Inheritance diagram for multiphaseMangrovesTurbulenceModel:

Collaboration diagram for multiphaseMangrovesTurbulenceModel:

[legend]

Public Member Functions
	TypeName ("multiphaseMangrovesTurbulenceModel")

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

virtual	~multiphaseMangrovesTurbulenceModel ()=default

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

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &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< 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	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 >	kCoeff (const volVectorField &U) const

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

Protected Member Functions inherited from option
void	resetApplied ()

Protected Attributes
scalarList	aZone_

scalarList	NZone_

scalarList	CkpZone_

scalarList	CepZone_

scalarList	CdZone_

labelListList	zoneIDs_

word	UName_

word	kName_

word	epsilonName_

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

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
	)

Definition at line 143 of file multiphaseMangrovesTurbulenceModel.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ ~multiphaseMangrovesTurbulenceModel()

virtual ~multiphaseMangrovesTurbulenceModel ( )

virtualdefault

Member Function Documentation

◆ kCoeff()

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

protected

Definition at line 50 of file multiphaseMangrovesTurbulenceModel.C.

References GeometricField::correctBoundaryConditions(), Foam::dimless, Foam::dimTime, forAll, Foam::mag(), N(), Foam::New(), GeometricField::ref(), U, and Foam::Zero.

Here is the call graph for this function:

◆ epsilonCoeff()

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

protected

Definition at line 96 of file multiphaseMangrovesTurbulenceModel.C.

References GeometricField::correctBoundaryConditions(), Foam::dimless, Foam::dimTime, forAll, Foam::mag(), N(), Foam::New(), GeometricField::ref(), U, and Foam::Zero.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "multiphaseMangrovesTurbulenceModel" )

◆ addSup() [1/2]

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

virtual

Reimplemented from option.

Definition at line 167 of file multiphaseMangrovesTurbulenceModel.C.

References fvMatrix::psi(), Sp, and U.

Here is the call graph for this function:

◆ addSup() [2/2]

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

virtual

Reimplemented from option.

Definition at line 194 of file multiphaseMangrovesTurbulenceModel.C.

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

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from option.

Definition at line 221 of file multiphaseMangrovesTurbulenceModel.C.

References 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::indices(), option::mesh_, ZoneMesh::names(), Foam::nl, multiphaseMangrovesTurbulenceModel::NZone_, option::read(), dictionary::readEntry(), dictionary::readIfPresent(), regionName, regionNames, option::resetApplied(), List::resize(), List::setSize(), dictionary::subDict(), dictionary::toc(), and multiphaseMangrovesTurbulenceModel::zoneIDs_.

Here is the call graph for this function:

Member Data Documentation

◆ aZone_

scalarList aZone_

protected

Definition at line 79 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by multiphaseMangrovesTurbulenceModel::read().

◆ NZone_

scalarList NZone_

protected

Definition at line 82 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by multiphaseMangrovesTurbulenceModel::read().

◆ CkpZone_

scalarList CkpZone_

protected

Definition at line 85 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by multiphaseMangrovesTurbulenceModel::read().

◆ CepZone_

scalarList CepZone_

protected

Definition at line 88 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by multiphaseMangrovesTurbulenceModel::read().

◆ CdZone_

scalarList CdZone_

protected

Definition at line 91 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by multiphaseMangrovesTurbulenceModel::read().

◆ zoneIDs_

labelListList zoneIDs_

protected

Definition at line 94 of file multiphaseMangrovesTurbulenceModel.H.

Referenced by multiphaseMangrovesTurbulenceModel::read().

◆ UName_

word UName_

protected

Definition at line 100 of file multiphaseMangrovesTurbulenceModel.H.

◆ kName_

word kName_

protected

Definition at line 103 of file multiphaseMangrovesTurbulenceModel.H.

◆ epsilonName_

word epsilonName_

protected

Definition at line 106 of file multiphaseMangrovesTurbulenceModel.H.

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_