Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
multiphaseMangrovesSource Class Reference
Numerics » Finite volume Options » Sources
Inheritance diagram for multiphaseMangrovesSource:
[legend]
Collaboration diagram for multiphaseMangrovesSource:
[legend]

Public Member Functions

 TypeName ("multiphaseMangrovesSource")
 Runtime type information. More...
 
 multiphaseMangrovesSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
virtual ~multiphaseMangrovesSource ()=default
 Destructor. More...
 
virtual void addSup (fvMatrix< vector > &eqn, const label fieldi)
 Add implicit contribution to momentum equation. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 Add implicit contribution to phase momentum equation. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
- Public Member Functions inherited from option
 TypeName ("option")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))
 
 option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
autoPtr< option > clone () const
 Return clone. More...
 
virtual ~option ()=default
 Destructor. More...
 
const word & name () const noexcept
 Return const access to the source name. More...
 
const fvMesh & mesh () const noexcept
 Return const access to the mesh database. More...
 
const dictionary & coeffs () const noexcept
 Return dictionary. More...
 
bool active () const noexcept
 True if source is active. More...
 
void setApplied (const label fieldi)
 Set the applied flag to true for field index fieldi. More...
 
bool active (const bool on) noexcept
 Change source active flag, return previous value. More...
 
virtual bool isActive ()
 Is the source active? More...
 
virtual label applyToField (const word &fieldName) const
 Return index of field name if found in fieldNames list. More...
 
virtual void checkApplied () const
 Check that the source has been applied. More...
 
virtual void addSup (fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< vector > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void correct (volScalarField &field)
 
virtual void correct (volVectorField &field)
 
virtual void correct (volSphericalTensorField &field)
 
virtual void correct (volSymmTensorField &field)
 
virtual void correct (volTensorField &field)
 
virtual void postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
 
virtual void postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
 
virtual void postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
 
virtual void writeHeader (Ostream &) const
 Write the source header information. More...
 
virtual void writeFooter (Ostream &) const
 Write the source footer information. More...
 
virtual void writeData (Ostream &) const
 Write the source properties. More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 

Protected Member Functions

tmp< volScalarField > dragCoeff (const volVectorField &U) const
 Return the drag force coefficient. More...
 
tmp< volScalarField > inertiaCoeff () const
 Return the inertia force coefficient. More...
 
- Protected Member Functions inherited from option
void resetApplied ()
 Resize/reset applied flag list for all fieldNames_ entries. More...
 

Protected Attributes

scalarList aZone_
 Width of the vegetation element. More...
 
scalarList NZone_
 Number of plants per unit of area. More...
 
scalarList CmZone_
 Inertia coefficient. More...
 
scalarList CdZone_
 Drag coefficient. More...
 
labelListList zoneIDs_
 Porosity coefficient. More...
 
- Protected Attributes inherited from option
const word name_
 Source name. More...
 
const word modelType_
 Model type. More...
 
const fvMesh & mesh_
 Reference to the mesh database. More...
 
dictionary dict_
 Top level source dictionary. More...
 
dictionary coeffs_
 Dictionary containing source coefficients. More...
 
wordList fieldNames_
 Field names to apply source to - populated by derived models. More...
 
List< bool > applied_
 Applied flag list - corresponds to each fieldNames_ entry. More...
 
bool active_
 Source active flag. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from option
static autoPtr< option > New (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvOption model. More...
 
- Public Attributes inherited from option
bool log
 Switch write log to Info. More...
 

Detailed Description

Usage
Source files

Definition at line 62 of file multiphaseMangrovesSource.H.

Constructor & Destructor Documentation

◆ multiphaseMangrovesSource()

multiphaseMangrovesSource ( const word &  name,
const word &  modelType,
const dictionary &  dict,
const fvMesh &  mesh 
)

Construct from components.

Definition at line 148 of file multiphaseMangrovesSource.C.

References dict, fv(), and multiphaseMangrovesSource::read().

Here is the call graph for this function:

◆ ~multiphaseMangrovesSource()

virtual ~multiphaseMangrovesSource ( )
virtualdefault

Destructor.

Member Function Documentation

◆ dragCoeff()

Foam::tmp< Foam::volScalarField > dragCoeff ( const volVectorField &  U) const
protected

Return the drag force coefficient.

Definition at line 57 of file multiphaseMangrovesSource.C.

References multiphaseMangrovesSource::aZone_, multiphaseMangrovesSource::CdZone_, polyMesh::cellZones(), Foam::dimless, Foam::dimTime, multiphaseMangrovesSource::dragCoeff(), forAll, Foam::mag(), option::mesh_, N(), Time::New(), IOobject::NO_READ, IOobject::NO_WRITE, multiphaseMangrovesSource::NZone_, fvMesh::time(), Time::timeName(), U, Foam::Zero, and multiphaseMangrovesSource::zoneIDs_.

Referenced by multiphaseMangrovesSource::dragCoeff().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ inertiaCoeff()

Foam::tmp< Foam::volScalarField > inertiaCoeff ( ) const
protected

Return the inertia force coefficient.

Definition at line 102 of file multiphaseMangrovesSource.C.

References Foam::dimless, forAll, N(), Time::New(), IOobject::NO_READ, IOobject::NO_WRITE, Foam::constant::mathematical::pi(), and Foam::Zero.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "multiphaseMangrovesSource"  )

Runtime type information.

◆ addSup() [1/2]

void addSup ( fvMatrix< vector > &  eqn,
const label  fieldi 
)
virtual

Add implicit contribution to momentum equation.

Reimplemented from option.

Definition at line 168 of file multiphaseMangrovesSource.C.

References Foam::fvm::ddt(), fvMatrix< Type >::psi(), Foam::fvm::Sp(), and U.

Here is the call graph for this function:

◆ addSup() [2/2]

void addSup ( const volScalarField &  rho,
fvMatrix< vector > &  eqn,
const label  fieldi 
)
virtual

Add implicit contribution to phase momentum equation.

Reimplemented from option.

Definition at line 187 of file multiphaseMangrovesSource.C.

References Foam::fvm::ddt(), fvMatrix< Type >::psi(), rho, Foam::fvm::Sp(), and U.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented from option.

Definition at line 207 of file multiphaseMangrovesSource.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, dictionary::get(), Foam::nl, kEpsilonLopesdaCosta< BasicTurbulenceModel >::read(), dictionary::readEntry(), regionName, regionNames, option::resetApplied(), dictionary::subDict(), and dictionary::toc().

Referenced by multiphaseMangrovesSource::multiphaseMangrovesSource().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ aZone_

scalarList aZone_
protected

Width of the vegetation element.

Definition at line 82 of file multiphaseMangrovesSource.H.

Referenced by multiphaseMangrovesSource::dragCoeff().

◆ NZone_

scalarList NZone_
protected

Number of plants per unit of area.

Definition at line 85 of file multiphaseMangrovesSource.H.

Referenced by multiphaseMangrovesSource::dragCoeff().

◆ CmZone_

scalarList CmZone_
protected

Inertia coefficient.

Definition at line 88 of file multiphaseMangrovesSource.H.

◆ CdZone_

scalarList CdZone_
protected

Drag coefficient.

Definition at line 91 of file multiphaseMangrovesSource.H.

Referenced by multiphaseMangrovesSource::dragCoeff().

◆ zoneIDs_

labelListList zoneIDs_
protected

Porosity coefficient.

scalarList MangrovesZone_; Zone indices

Definition at line 97 of file multiphaseMangrovesSource.H.

Referenced by multiphaseMangrovesSource::dragCoeff().

The documentation for this class was generated from the following files: