Base class for packing models. More...

#include <PackingModel.H>

Inheritance diagram for PackingModel< CloudType >:

[legend]

Collaboration diagram for PackingModel< CloudType >:

[legend]

Public Member Functions
	TypeName ("packingModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, PackingModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
	PackingModel (CloudType &owner)
	Construct null from owner.
	PackingModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components.
	PackingModel (const PackingModel< CloudType > &cm)
	Construct copy.
virtual autoPtr< PackingModel< CloudType > >	clone () const =0
	Construct and return a clone.
virtual	~PackingModel ()
	Destructor.
virtual vector	velocityCorrection (typename CloudType::parcelType &p, const scalar deltaT) const =0
	Calculate the velocity correction.
Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud.
	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name.
	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name.
	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy.
virtual	~CloudSubModelBase ()=default
	Destructor.
const CloudType &	owner () const
	Return const access to the owner cloud.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
virtual fileName	localPath () const
	Output directory.
CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation.
virtual void	info ()
	Write to info.
virtual void	write (Ostream &os) const
	Write to os.
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual bool	active () const
	Return the model 'active' status - default active = true.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.

Static Public Member Functions
static autoPtr< PackingModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.

Protected Attributes
autoPtr< ParticleStressModel >	particleStressModel_
	Protected data.
Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.

Detailed Description

template<class CloudType>
class Foam::PackingModel< CloudType >

Base class for packing models.

Source files

Definition at line 64 of file PackingModel.H.

Constructor & Destructor Documentation

◆ PackingModel() [1/3]

template<class CloudType>

PackingModel ( CloudType & owner )

Construct null from owner.

Definition at line 30 of file PackingModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), CloudSubModelBase< CloudType >::owner(), and particleStressModel_.

Referenced by declareRunTimeSelectionTable(), Explicit< CloudType >::Explicit(), Explicit< CloudType >::Explicit(), Implicit< CloudType >::Implicit(), Implicit< CloudType >::Implicit(), NoPacking< CloudType >::NoPacking(), NoPacking< CloudType >::NoPacking(), and PackingModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PackingModel() [2/3]

template<class CloudType>

PackingModel	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	type )

Construct from components.

Definition at line 38 of file PackingModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), subModelBase::coeffDict(), subModelBase::dict(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, New(), CloudSubModelBase< CloudType >::owner(), and particleStressModel_.

Here is the call graph for this function:

◆ PackingModel() [3/3]

template<class CloudType>

PackingModel ( const PackingModel< CloudType > & cm )

Construct copy.

Definition at line 57 of file PackingModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), PackingModel(), and particleStressModel_.

Here is the call graph for this function:

◆ ~PackingModel()

template<class CloudType>

~PackingModel ( )

virtual

Destructor.

Definition at line 67 of file PackingModel.C.

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "packingModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CloudType>

declareRunTimeSelectionTable	(	autoPtr	,
		PackingModel< CloudType >	,
		dictionary	,
		(const dictionary &dict, CloudType &owner)	,
		(dict, owner)	)

Declare runtime constructor selection table.

References subModelBase::dict(), CloudSubModelBase< CloudType >::owner(), and PackingModel().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

virtual autoPtr< PackingModel< CloudType > > clone ( ) const

pure virtual

Construct and return a clone.

Implemented in Explicit< CloudType >, Implicit< CloudType >, and NoPacking< CloudType >.

References subModelBase::dict(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ New()

template<class CloudType>

Foam::autoPtr< Foam::PackingModel< CloudType > > New	(	const dictionary &	dict,
		CloudType &	owner )

static

Selector.

Definition at line 75 of file PackingModel.C.

References Foam::abort(), subModelBase::dict(), Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::Info, subModelBase::modelType(), and CloudSubModelBase< CloudType >::owner().

Referenced by Explicit< CloudType >::Explicit(), and PackingModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ velocityCorrection()

template<class CloudType>

virtual vector velocityCorrection	(	typename CloudType::parcelType &	p,
		const scalar	deltaT ) const

pure virtual

Calculate the velocity correction.

Implemented in Explicit< CloudType >, Implicit< CloudType >, and NoPacking< CloudType >.

References p.

Member Data Documentation

◆ particleStressModel_

template<class CloudType>

autoPtr<ParticleStressModel> particleStressModel_

protected

Protected data.

Particle stress model

Definition at line 77 of file PackingModel.H.

Referenced by Explicit< CloudType >::cacheFields(), Implicit< CloudType >::cacheFields(), PackingModel(), PackingModel(), and PackingModel().

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

src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H
src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.H
src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PackingModel() [1/3]

◆ PackingModel() [2/3]

◆ PackingModel() [3/3]

◆ ~PackingModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ velocityCorrection()

Member Data Documentation

◆ particleStressModel_