#include <multiphaseMangrovesTurbulenceModel.H>

Inheritance diagram for multiphaseMangrovesTurbulenceModel:

Collaboration diagram for multiphaseMangrovesTurbulenceModel:

[legend]

Public Member Functions
	TypeName ("multiphaseMangrovesTurbulenceModel")
	Runtime type information.
	multiphaseMangrovesTurbulenceModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
virtual	~multiphaseMangrovesTurbulenceModel ()=default
	Destructor.
virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)
	Add implicit contribution to momentum equation.
virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
	Add implicit contribution to compressible momentum equation.
virtual bool	read (const dictionary &dict)
	Read dictionary.
Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information.
	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.
autoPtr< option >	clone () const
	Return clone.
virtual	~option ()=default
	Destructor.
const word &	name () const noexcept
	Return const access to the source name.
const fvMesh &	mesh () const noexcept
	Return const access to the mesh database.
const dictionary &	coeffs () const noexcept
	Return dictionary.
bool	active () const noexcept
	True if source is active.
void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi.
bool	active (const bool on) noexcept
	Change source active flag, return previous value.
virtual bool	isActive ()
	Is the source active?
virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list.
virtual void	checkApplied () const
	Check that the source has been applied.
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	correct (surfaceScalarField &field)
virtual void	correct (surfaceVectorField &field)
virtual void	correct (surfaceTensorField &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	postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	writeHeader (Ostream &) const
	Write the source header information.
virtual void	writeFooter (Ostream &) const
	Write the source footer information.
virtual void	writeData (Ostream &) const
	Write the source properties.

Protected Member Functions
tmp< volScalarField >	kCoeff (const volVectorField &U) const
	Return the k coefficient.
tmp< volScalarField >	epsilonCoeff (const volVectorField &U) const
	Return the epsilon coefficient.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.

Protected Attributes
scalarList	aZone_
	Width of the vegetation element.
scalarList	NZone_
	Number of plants per unit of area.
scalarList	CkpZone_
	Ckp.
scalarList	CepZone_
	Cep.
scalarList	CdZone_
	Drag coefficient.
labelListList	zoneIDs_
	Zone indices.
word	UName_
	Name of U; default = U.
word	kName_
	Name of k; default = k.
word	epsilonName_
	Name of epsilon; default = epsilon.
Protected Attributes inherited from option
const word	name_
	Source name.
const word	modelType_
	Model type.
const fvMesh &	mesh_
	Reference to the mesh database.
dictionary	dict_
	Top level source dictionary.
dictionary	coeffs_
	Dictionary containing source coefficients.
wordList	fieldNames_
	Field names to apply source to - populated by derived models.
List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry.
bool	active_
	Source active flag.

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.
Public Attributes inherited from option
bool	log
	Switch write log to Info.

Detailed Description

Usage

Source files

Definition at line 55 of file multiphaseMangrovesTurbulenceModel.H.

Constructor & Destructor Documentation

◆ multiphaseMangrovesTurbulenceModel()

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

Construct from components.

Definition at line 127 of file multiphaseMangrovesTurbulenceModel.C.

References aZone_, CdZone_, CepZone_, CkpZone_, dict, epsilonName_, kName_, option::mesh(), option::name(), NZone_, option::option(), read(), and UName_.

Here is the call graph for this function:

◆ ~multiphaseMangrovesTurbulenceModel()

virtual ~multiphaseMangrovesTurbulenceModel ( )

virtualdefault

Destructor.

References dict, and rho.

Member Function Documentation

◆ kCoeff()

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

protected

Return the k coefficient.

Definition at line 49 of file multiphaseMangrovesTurbulenceModel.C.

References aZone_, CdZone_, CkpZone_, Foam::dimless, Foam::dimTime, forAll, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, kCoeff(), Foam::mag(), option::mesh_, N(), GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, NZone_, IOobject::scopedName(), U, Foam::Zero, and zoneIDs_.

Referenced by addSup(), addSup(), and kCoeff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ epsilonCoeff()

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

protected

Return the epsilon coefficient.

Definition at line 88 of file multiphaseMangrovesTurbulenceModel.C.

References aZone_, CdZone_, CepZone_, Foam::dimless, Foam::dimTime, epsilonCoeff(), forAll, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::mag(), option::mesh_, N(), GeometricField< scalar, fvPatchField, volMesh >::New(), NZone_, IOobject::scopedName(), U, Foam::Zero, and zoneIDs_.

Referenced by addSup(), addSup(), and epsilonCoeff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "multiphaseMangrovesTurbulenceModel" )

Runtime type information.

References dict, option::mesh(), and option::name().

Here is the call graph for this function:

◆ addSup() [1/2]

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

virtual

Add implicit contribution to momentum equation.

Reimplemented from option.

Definition at line 151 of file multiphaseMangrovesTurbulenceModel.C.

References epsilonCoeff(), epsilonName_, kCoeff(), kName_, option::mesh_, IOobject::name(), fvMatrix< Type >::psi(), Foam::fvm::Sp(), U, and UName_.

Here is the call graph for this function:

◆ addSup() [2/2]

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

virtual

Add implicit contribution to compressible momentum equation.

Reimplemented from option.

Definition at line 178 of file multiphaseMangrovesTurbulenceModel.C.

References epsilonCoeff(), epsilonName_, kCoeff(), kName_, option::mesh_, IOobject::name(), fvMatrix< Type >::psi(), rho, Foam::fvm::Sp(), U, and UName_.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from option.

Definition at line 206 of file multiphaseMangrovesTurbulenceModel.C.

References aZone_, CdZone_, CepZone_, CkpZone_, option::coeffs_, dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, option::fieldNames_, forAll, dictionary::get(), option::mesh_, Foam::nl, NZone_, option::read(), dictionary::readEntry(), regionName, regionNames, option::resetApplied(), dictionary::subDict(), dictionary::toc(), and zoneIDs_.

Referenced by multiphaseMangrovesTurbulenceModel().

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 85 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by epsilonCoeff(), kCoeff(), multiphaseMangrovesTurbulenceModel(), and read().

◆ NZone_

scalarList NZone_

protected

Number of plants per unit of area.

Definition at line 90 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by epsilonCoeff(), kCoeff(), multiphaseMangrovesTurbulenceModel(), and read().

◆ CkpZone_

scalarList CkpZone_

protected

Ckp.

Definition at line 95 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by kCoeff(), multiphaseMangrovesTurbulenceModel(), and read().

◆ CepZone_

scalarList CepZone_

protected

Cep.

Definition at line 100 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by epsilonCoeff(), multiphaseMangrovesTurbulenceModel(), and read().

◆ CdZone_

scalarList CdZone_

protected

Drag coefficient.

Definition at line 105 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by epsilonCoeff(), kCoeff(), multiphaseMangrovesTurbulenceModel(), and read().

◆ zoneIDs_

labelListList zoneIDs_

protected

Zone indices.

Definition at line 110 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by epsilonCoeff(), kCoeff(), and read().

◆ UName_

word UName_

protected

Name of U; default = U.

Definition at line 118 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by addSup(), addSup(), and multiphaseMangrovesTurbulenceModel().

◆ kName_

word kName_

protected

Name of k; default = k.

Definition at line 123 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by addSup(), addSup(), and multiphaseMangrovesTurbulenceModel().

◆ epsilonName_

word epsilonName_

protected

Name of epsilon; default = epsilon.

Definition at line 128 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by addSup(), addSup(), and multiphaseMangrovesTurbulenceModel().

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

src/waveModels/fvOptions/multiphaseMangrovesTurbulenceModel/multiphaseMangrovesTurbulenceModel.H
src/waveModels/fvOptions/multiphaseMangrovesTurbulenceModel/multiphaseMangrovesTurbulenceModel.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ multiphaseMangrovesTurbulenceModel()

◆ ~multiphaseMangrovesTurbulenceModel()

Member Function Documentation

◆ kCoeff()

◆ epsilonCoeff()

◆ TypeName()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ read()

Member Data Documentation

◆ aZone_

◆ NZone_

◆ CkpZone_

◆ CepZone_

◆ CdZone_

◆ zoneIDs_

◆ UName_

◆ kName_

◆ epsilonName_