multiphaseMangrovesSource Class Reference

#include <multiphaseMangrovesSource.H>

Inheritance diagram for multiphaseMangrovesSource:

Collaboration diagram for multiphaseMangrovesSource:

Public Member Functions
	TypeName ("multiphaseMangrovesSource")
	Runtime type information.
	multiphaseMangrovesSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
virtual	~multiphaseMangrovesSource ()=default
	Destructor.
virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
	Add implicit contribution to momentum equation.
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
	Add implicit contribution to phase 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< scalar > &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< 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 >	dragCoeff (const volVectorField &U) const
	Return the drag force coefficient.
tmp< volScalarField >	inertiaCoeff () const
	Return the inertia force 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	CmZone_
	Inertia coefficient.
scalarList	CdZone_
	Drag coefficient.
labelListList	zoneIDs_
	Porosity coefficient.
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

• multiphaseMangrovesSource.H
• multiphaseMangrovesSource.C

Definition at line 58 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 129 of file multiphaseMangrovesSource.C.

References aZone_, CdZone_, CmZone_, dict, option::mesh(), option::name(), NZone_, option::option(), and read().

Here is the call graph for this function:

~multiphaseMangrovesSource()

virtual ~multiphaseMangrovesSource ( )

virtualdefault

Destructor.

References dict, and rho.

Member Function Documentation

dragCoeff()

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

protected

Return the drag force coefficient.

Definition at line 50 of file multiphaseMangrovesSource.C.

References aZone_, CdZone_, Foam::dimless, Foam::dimTime, dragCoeff(), forAll, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, 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 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 89 of file multiphaseMangrovesSource.C.

References aZone_, CmZone_, Foam::dimless, forAll, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, inertiaCoeff(), option::mesh_, N(), GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, NZone_, Foam::constant::mathematical::pi(), pi(), IOobject::scopedName(), Foam::Zero, and zoneIDs_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"multiphaseMangrovesSource"

)

Runtime type information.

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

Here is the call graph for this function:

addSup() [1/2]

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

virtual

Add implicit contribution to momentum equation.

Reimplemented from option.

Definition at line 149 of file multiphaseMangrovesSource.C.

References Foam::fvm::ddt(), dragCoeff(), inertiaCoeff(), 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 168 of file multiphaseMangrovesSource.C.

References Foam::fvm::ddt(), dragCoeff(), inertiaCoeff(), 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 188 of file multiphaseMangrovesSource.C.

References aZone_, CdZone_, CmZone_, 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 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 84 of file multiphaseMangrovesSource.H.

Referenced by dragCoeff(), inertiaCoeff(), multiphaseMangrovesSource(), and read().

NZone_

scalarList NZone_

protected

Number of plants per unit of area.

Definition at line 89 of file multiphaseMangrovesSource.H.

Referenced by dragCoeff(), inertiaCoeff(), multiphaseMangrovesSource(), and read().

CmZone_

scalarList CmZone_

protected

Inertia coefficient.

Definition at line 94 of file multiphaseMangrovesSource.H.

Referenced by inertiaCoeff(), multiphaseMangrovesSource(), and read().

CdZone_

scalarList CdZone_

protected

Drag coefficient.

Definition at line 99 of file multiphaseMangrovesSource.H.

Referenced by dragCoeff(), multiphaseMangrovesSource(), and read().

zoneIDs_

labelListList zoneIDs_

protected

Porosity coefficient.

scalarList MangrovesZone_;

Zone indices

Definition at line 110 of file multiphaseMangrovesSource.H.

Referenced by dragCoeff(), inertiaCoeff(), and read().

---

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

• src/waveModels/fvOptions/multiphaseMangrovesSource/multiphaseMangrovesSource.H
• src/waveModels/fvOptions/multiphaseMangrovesSource/multiphaseMangrovesSource.C