Base class for generic sub-models requiring to be read from dictionary. Provides a mechanism to read and write properties from a dictionary to enable clean re-starts. Used by, e.g. clou dsub-models. More...

Inheritance diagram for subModelBase:

[legend]

Collaboration diagram for subModelBase:

[legend]

Public Member Functions
	subModelBase (dictionary &properties)
	Construct null. More...

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name. More...

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name. More...

	subModelBase (const subModelBase &smb)
	Copy constructor. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () const
	Return const access to the properties dictionary. More...

virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg. More...

virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

virtual bool	writeTime () const =0
	Flag to indicate when to write a property. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the base model. More...

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model. More...

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model. More...

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model. More...

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the sub-model. More...

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model. More...

virtual void	write (Ostream &os) const
	Write. More...

void	operator= (const subModelBase &)=delete
	Disallow default bitwise assignment. More...

Protected Member Functions
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	Reference to properties dictionary e.g. for restart. More...

const dictionary	dict_
	Copy of dictionary used during construction. More...

const word	baseName_
	Name of the sub-model base class. More...

const word	modelType_
	Type of the sub-model. More...

const dictionary	coeffDict_
	Coefficients dictionary. More...

Detailed Description

Base class for generic sub-models requiring to be read from dictionary. Provides a mechanism to read and write properties from a dictionary to enable clean re-starts. Used by, e.g. clou dsub-models.

Source files

Definition at line 51 of file subModelBase.H.

Constructor & Destructor Documentation

◆ subModelBase() [1/4]

subModelBase ( dictionary & properties )

Construct null.

Definition at line 38 of file subModelBase.C.

Referenced by subModelBase::subModelBase().

Here is the caller graph for this function:

◆ subModelBase() [2/4]

subModelBase	(	dictionary &	properties,
		const dictionary &	dict,
		const word &	baseName,
		const word &	modelType,
		const word &	dictExt = `"Coeffs"`
	)

Construct from components without name.

Definition at line 50 of file subModelBase.C.

References subModelBase::subModelBase().

Here is the call graph for this function:

◆ subModelBase() [3/4]

subModelBase	(	const word &	modelName,
		dictionary &	properties,
		const dictionary &	dict,
		const word &	baseName,
		const word &	modelType
	)

Construct from components with name.

Definition at line 68 of file subModelBase.C.

◆ subModelBase() [4/4]

subModelBase ( const subModelBase & smb )

Copy constructor.

Definition at line 85 of file subModelBase.C.

◆ ~subModelBase()

~subModelBase ( )

virtual

Destructor.

Definition at line 98 of file subModelBase.C.

Member Function Documentation

◆ inLine()

bool inLine ( ) const

protected

Flag to indicate whether data is/was read in-line.

◆ modelName()

const Foam::word & modelName ( ) const

Return const access to the name of the sub-model.

Definition at line 104 of file subModelBase.C.

References subModelBase::modelName_.

Referenced by CloudFunctionObject< CloudType >::CloudFunctionObject(), and InjectionModel< CloudType >::info().

Here is the caller graph for this function:

◆ dict()

const Foam::dictionary & dict ( ) const

Return const access to the cloud dictionary.

Definition at line 110 of file subModelBase.C.

References subModelBase::dict_.

◆ baseName()

const Foam::word & baseName ( ) const

Return const access to the base name of the sub-model.

Definition at line 116 of file subModelBase.C.

References subModelBase::baseName_.

◆ modelType()

const Foam::word & modelType ( ) const

Return const access to the sub-model type.

Definition at line 122 of file subModelBase.C.

References subModelBase::modelType_.

Referenced by filmSubModelBase::filmType().

Here is the caller graph for this function:

◆ coeffDict()

const Foam::dictionary & coeffDict ( ) const

Return const access to the coefficients dictionary.

Definition at line 128 of file subModelBase.C.

References subModelBase::coeffDict_.

Referenced by InjectionModel< CloudType >::InjectionModel().

Here is the caller graph for this function:

◆ properties()

const Foam::dictionary & properties ( ) const

Return const access to the properties dictionary.

Definition at line 134 of file subModelBase.C.

References subModelBase::properties_.

Referenced by LiquidEvaporation< CloudType >::dh(), and LiquidEvaporationBoil< CloudType >::dh().

Here is the caller graph for this function:

◆ defaultCoeffs()

bool defaultCoeffs ( const bool printMsg ) const

virtual

Returns true if defaultCoeffs is true and outputs on printMsg.

Definition at line 140 of file subModelBase.C.

References subModelBase::coeffDict_, Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), Foam::Info, and dictionary::lookupOrDefault().

Here is the call graph for this function:

◆ cacheFields()

void cacheFields ( const bool store )

virtual

Cache dependent sub-model fields.

Reimplemented in DispersionRASModel< CloudType >, Explicit< CloudType >, Implicit< CloudType >, Relaxation< CloudType >, and GradientDispersionRAS< CloudType >.

Definition at line 154 of file subModelBase.C.

◆ writeTime()

virtual bool writeTime ( ) const

pure virtual

Flag to indicate when to write a property.

◆ getBaseProperty() [1/2]

Type getBaseProperty	(	const word &	entryName,
		const Type &	defaultValue = `pTraits<Type>::zero`
	)		const

Retrieve generic property from the base model.

Definition at line 30 of file subModelBaseTemplates.C.

References dictionary::readIfPresent(), and dictionary::subDict().

Referenced by ejectionModelList::info(), and transferModelList::info().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBaseProperty() [2/2]

void getBaseProperty	(	const word &	entryName,
		Type &	value
	)		const

Retrieve generic property from the base model.

Definition at line 49 of file subModelBaseTemplates.C.

References dictionary::readIfPresent(), subModelBase::setBaseProperty(), and dictionary::subDict().

Here is the call graph for this function:

◆ setBaseProperty()

void setBaseProperty	(	const word &	entryName,
		const Type &	value
	)

Add generic property to the base model.

Definition at line 64 of file subModelBaseTemplates.C.

References dictionary::add(), subModelBase::getModelProperty(), and dictionary::subDict().

Referenced by subModelBase::getBaseProperty(), ejectionModelList::info(), and transferModelList::info().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModelProperty() [1/2]

void getModelProperty	(	const word &	entryName,
		Type &	value
	)		const

Retrieve generic property from the sub-model.

Definition at line 84 of file subModelBaseTemplates.C.

References dictionary::found(), dictionary::readIfPresent(), and dictionary::subDict().

Referenced by subModelBase::setBaseProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModelProperty() [2/2]

Type getModelProperty	(	const word &	entryName,
		const Type &	defaultValue = `pTraits<Type>::zero`
	)		const

Retrieve generic property from the sub-model.

Definition at line 107 of file subModelBaseTemplates.C.

References subModelBase::setModelProperty().

Here is the call graph for this function:

◆ setModelProperty()

void setModelProperty	(	const word &	entryName,
		const Type &	value
	)

Add generic property to the sub-model.

Definition at line 120 of file subModelBaseTemplates.C.

References dictionary::add(), dictionary::found(), and dictionary::subDict().

Referenced by subModelBase::getModelProperty(), and InjectionModel< CloudType >::info().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 158 of file subModelBase.C.

References subModelBase::coeffDict_.

◆ operator=()

void operator= ( const subModelBase & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ modelName_

const word modelName_

protected

Name of the sub-model.

Definition at line 59 of file subModelBase.H.

Referenced by subModelBase::modelName().

◆ properties_

dictionary& properties_

protected

Reference to properties dictionary e.g. for restart.

Definition at line 62 of file subModelBase.H.

Referenced by subModelBase::properties().

◆ dict_

const dictionary dict_

protected

Copy of dictionary used during construction.

Definition at line 65 of file subModelBase.H.

Referenced by subModelBase::dict().

◆ baseName_

const word baseName_

protected

Name of the sub-model base class.

Definition at line 68 of file subModelBase.H.

Referenced by subModelBase::baseName().

◆ modelType_

const word modelType_

protected

Type of the sub-model.

Definition at line 71 of file subModelBase.H.

Referenced by subModelBase::modelType().

◆ coeffDict_

const dictionary coeffDict_

protected

Coefficients dictionary.

Definition at line 74 of file subModelBase.H.

Referenced by subModelBase::coeffDict(), subModelBase::defaultCoeffs(), and subModelBase::write().

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

src/OpenFOAM/primitives/subModelBase/subModelBase.H
src/OpenFOAM/primitives/subModelBase/subModelBase.C
src/OpenFOAM/primitives/subModelBase/subModelBaseTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ subModelBase() [1/4]

◆ subModelBase() [2/4]

◆ subModelBase() [3/4]

◆ subModelBase() [4/4]

◆ ~subModelBase()

Member Function Documentation

◆ inLine()

◆ modelName()

◆ dict()

◆ baseName()

◆ modelType()

◆ coeffDict()

◆ properties()

◆ defaultCoeffs()

◆ cacheFields()

◆ writeTime()

◆ getBaseProperty() [1/2]

◆ getBaseProperty() [2/2]

◆ setBaseProperty()

◆ getModelProperty() [1/2]

◆ getModelProperty() [2/2]

◆ setModelProperty()

◆ write()

◆ operator=()

Member Data Documentation

◆ modelName_

◆ properties_

◆ dict_

◆ baseName_

◆ modelType_

◆ coeffDict_