Public Member Functions | |
TypeName ("multiphaseMangrovesTurbulenceModel") | |
Runtime type information. More... | |
multiphaseMangrovesTurbulenceModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh) | |
Construct from components. More... | |
virtual | ~multiphaseMangrovesTurbulenceModel ()=default |
Destructor. More... | |
virtual void | addSup (fvMatrix< scalar > &eqn, const label fieldi) |
Add implicit contribution to momentum equation. More... | |
virtual void | addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi) |
Add implicit contribution to compressible 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 |
Return const access to the source name. More... | |
const fvMesh & | mesh () const |
Return const access to the mesh database. More... | |
const dictionary & | coeffs () const |
Return dictionary. More... | |
bool | active () const |
Return const access to the source active flag. More... | |
void | setApplied (const label fieldi) |
Set the applied flag to true for field index fieldi. More... | |
Switch & | active () |
Return access to the source active flag. 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< 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< 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 | 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... | |
Protected Member Functions | |
tmp< volScalarField > | kCoeff (const volVectorField &U) const |
Return the k coefficient. More... | |
tmp< volScalarField > | epsilonCoeff (const volVectorField &U) const |
Return the epsilon coefficient. More... | |
Protected Attributes | |
scalarList | aZone_ |
Width of the vegetation element. More... | |
scalarList | NZone_ |
Number of plants per unit of area. More... | |
scalarList | CkpZone_ |
Ckp. More... | |
scalarList | CepZone_ |
Cep. More... | |
scalarList | CdZone_ |
Drag coefficient. More... | |
labelListList | zoneIDs_ |
Zone indices. More... | |
word | UName_ |
Name of U; default = U. More... | |
word | kName_ |
Name of k; default = k. More... | |
word | epsilonName_ |
Name of epsilon; default = epsilon. 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... | |
Switch | active_ |
Source active flag. 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... | |
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... | |
Definition at line 59 of file multiphaseMangrovesTurbulenceModel.H.
multiphaseMangrovesTurbulenceModel | ( | const word & | name, |
const word & | modelType, | ||
const dictionary & | dict, | ||
const fvMesh & | mesh | ||
) |
Construct from components.
Definition at line 150 of file multiphaseMangrovesTurbulenceModel.C.
References dict, and Foam::blockMeshTools::read().
|
virtualdefault |
Destructor.
|
protected |
Return the k coefficient.
Definition at line 57 of file multiphaseMangrovesTurbulenceModel.C.
References Foam::dimless, Foam::dimTime, forAll, Foam::mag(), N(), Foam::New(), GeometricField< Type, PatchField, GeoMesh >::ref(), U, and Foam::Zero.
|
protected |
Return the epsilon coefficient.
Definition at line 103 of file multiphaseMangrovesTurbulenceModel.C.
References Foam::dimless, Foam::dimTime, forAll, Foam::mag(), N(), Foam::New(), GeometricField< Type, PatchField, GeoMesh >::ref(), U, and Foam::Zero.
TypeName | ( | "multiphaseMangrovesTurbulenceModel" | ) |
Runtime type information.
Add implicit contribution to momentum equation.
Reimplemented from option.
Definition at line 174 of file multiphaseMangrovesTurbulenceModel.C.
References fvMatrix< Type >::psi(), Sp, and U.
|
virtual |
Add implicit contribution to compressible momentum equation.
Reimplemented from option.
Definition at line 201 of file multiphaseMangrovesTurbulenceModel.C.
References fvMatrix< Type >::psi(), rho, Sp, and U.
|
virtual |
Read dictionary.
Reimplemented from option.
Definition at line 228 of file multiphaseMangrovesTurbulenceModel.C.
References option::applied_, multiphaseMangrovesTurbulenceModel::aZone_, multiphaseMangrovesTurbulenceModel::CdZone_, polyMesh::cellZones(), multiphaseMangrovesTurbulenceModel::CepZone_, multiphaseMangrovesTurbulenceModel::CkpZone_, option::coeffs_, dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, option::fieldNames_, forAll, dictionary::found(), dictionary::get(), ZoneMesh< ZoneType, MeshType >::indices(), option::mesh_, ZoneMesh< ZoneType, MeshType >::names(), Foam::nl, multiphaseMangrovesTurbulenceModel::NZone_, option::read(), dictionary::readEntry(), dictionary::readIfPresent(), regionName, List< T >::resize(), List< T >::setSize(), dictionary::subDict(), and multiphaseMangrovesTurbulenceModel::zoneIDs_.
|
protected |
Width of the vegetation element.
Definition at line 83 of file multiphaseMangrovesTurbulenceModel.H.
Referenced by multiphaseMangrovesTurbulenceModel::read().
|
protected |
Number of plants per unit of area.
Definition at line 86 of file multiphaseMangrovesTurbulenceModel.H.
Referenced by multiphaseMangrovesTurbulenceModel::read().
|
protected |
Ckp.
Definition at line 89 of file multiphaseMangrovesTurbulenceModel.H.
Referenced by multiphaseMangrovesTurbulenceModel::read().
|
protected |
Cep.
Definition at line 92 of file multiphaseMangrovesTurbulenceModel.H.
Referenced by multiphaseMangrovesTurbulenceModel::read().
|
protected |
Drag coefficient.
Definition at line 95 of file multiphaseMangrovesTurbulenceModel.H.
Referenced by multiphaseMangrovesTurbulenceModel::read().
|
protected |
Zone indices.
Definition at line 98 of file multiphaseMangrovesTurbulenceModel.H.
Referenced by multiphaseMangrovesTurbulenceModel::read().
|
protected |
Name of U; default = U.
Definition at line 104 of file multiphaseMangrovesTurbulenceModel.H.
|
protected |
Name of k; default = k.
Definition at line 107 of file multiphaseMangrovesTurbulenceModel.H.
|
protected |
Name of epsilon; default = epsilon.
Definition at line 110 of file multiphaseMangrovesTurbulenceModel.H.