multiphaseMangrovesSource Class Reference

Inheritance diagram for multiphaseMangrovesSource:

Collaboration diagram for multiphaseMangrovesSource:

Public Member Functions
	TypeName ("multiphaseMangrovesSource")
	multiphaseMangrovesSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
virtual	~multiphaseMangrovesSource ()=default
virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
virtual bool	read (const dictionary &dict)
Public Member Functions inherited from option
	TypeName ("option")
	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)
autoPtr< option >	clone () const
virtual	~option ()=default
const word &	name () const noexcept
const fvMesh &	mesh () const noexcept
const dictionary &	coeffs () const noexcept
bool	active () const noexcept
void	setApplied (const label fieldi)
bool	active (const bool on) noexcept
virtual bool	isActive ()
virtual label	applyToField (const word &fieldName) const
virtual void	checkApplied () const
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	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
virtual void	writeFooter (Ostream &) const
virtual void	writeData (Ostream &) const

Protected Member Functions
tmp< volScalarField >	dragCoeff (const volVectorField &U) const
tmp< volScalarField >	inertiaCoeff () const
Protected Member Functions inherited from option
void	resetApplied ()

Protected Attributes
scalarList	aZone_
scalarList	NZone_
scalarList	CmZone_
scalarList	CdZone_
labelListList	zoneIDs_
Protected Attributes inherited from option
const word	name_
const word	modelType_
const fvMesh &	mesh_
dictionary	dict_
dictionary	coeffs_
wordList	fieldNames_
List< bool >	applied_
bool	active_

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
Public Attributes inherited from option
bool	log

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
	)

Definition at line 142 of file multiphaseMangrovesSource.C.

References dict, and Foam::read().

Here is the call graph for this function:

~multiphaseMangrovesSource()

virtual ~multiphaseMangrovesSource ( )

virtualdefault

Member Function Documentation

dragCoeff()

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

protected

Definition at line 50 of file multiphaseMangrovesSource.C.

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

Here is the call graph for this function:

inertiaCoeff()

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

protected

Definition at line 95 of file multiphaseMangrovesSource.C.

References Foam::dimless, forAll, N(), tmp::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"

)

addSup() [1/2]

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

virtual

Reimplemented from option.

Definition at line 162 of file multiphaseMangrovesSource.C.

References Foam::fvm::ddt(), fvMatrix::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

Reimplemented from option.

Definition at line 181 of file multiphaseMangrovesSource.C.

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

Here is the call graph for this function:

read()

bool read ( const dictionary &  dict )

virtual

Reimplemented from option.

Definition at line 200 of file multiphaseMangrovesSource.C.

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

Here is the call graph for this function:

Member Data Documentation

aZone_

scalarList aZone_

protected

Definition at line 78 of file multiphaseMangrovesSource.H.

Referenced by multiphaseMangrovesSource::dragCoeff().

NZone_

scalarList NZone_

protected

Definition at line 81 of file multiphaseMangrovesSource.H.

Referenced by multiphaseMangrovesSource::dragCoeff().

CmZone_

scalarList CmZone_

protected

Definition at line 84 of file multiphaseMangrovesSource.H.

CdZone_

scalarList CdZone_

protected

Definition at line 87 of file multiphaseMangrovesSource.H.

Referenced by multiphaseMangrovesSource::dragCoeff().

zoneIDs_

labelListList zoneIDs_

protected

Definition at line 93 of file multiphaseMangrovesSource.H.

Referenced by multiphaseMangrovesSource::dragCoeff().

---

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

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