Creates particle void fraction field on carrier phase. More...

Inheritance diagram for VoidFraction< CloudType >:

Collaboration diagram for VoidFraction< CloudType >:

Public Member Functions
	TypeName ("voidFraction")
	Runtime type information. More...

	VoidFraction (const dictionary &dict, CloudType &owner, const word &modelName)
	Construct from dictionary. More...

	VoidFraction (const VoidFraction< CloudType > &vf)
	Construct copy. More...

virtual autoPtr< CloudFunctionObject< CloudType > >	clone () const
	Construct and return a clone. More...

virtual	~VoidFraction ()
	Destructor. More...

virtual void	preEvolve ()
	Pre-evolve hook. More...

virtual void	postEvolve ()
	Post-evolve hook. More...

virtual void	postMove (parcelType &p, const label cellI, const scalar dt, const point &position0, bool &keepParticle)
	Post-move hook. More...

Public Member Functions inherited from CloudFunctionObject< CloudType >
	TypeName ("cloudFunctionObject")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))
	Declare runtime constructor selection table. More...

	CloudFunctionObject (CloudType &owner)
	Construct null from owner. More...

	CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	Construct from dictionary. More...

	CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)
	Construct copy. More...

virtual	~CloudFunctionObject ()
	Destructor. More...

virtual void	postPatch (const typename CloudType::parcelType &p, const polyPatch &pp, const scalar trackFraction, const tetIndices &testIs, bool &keepParticle)
	Post-patch hook. More...

virtual void	postFace (const typename CloudType::parcelType &p, const label faceI, bool &keepParticle)
	Post-face hook. More...

const fileName &	outputDir () const
	Return the output path. More...

fileName	outputTimeDir () const
	Return the output time path. More...

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud. More...

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name. More...

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name. More...

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy. More...

virtual	~CloudSubModelBase ()
	Destructor. More...

const CloudType &	owner () const
	Return const access to the owner cloud. More...

virtual bool	outputTime () const
	Flag to indicate when to write a property. More...

CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation. More...

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

Public Member Functions inherited from subModelBase
	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)
	Construct as copy. 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 bool	active () const
	Return the model 'active' status - default active = true. More...

virtual void	cacheFields (const bool store)
	Cache dependant sub-model fields. 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...

Protected Member Functions
virtual void	write ()
	Write post-processing info. More...

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

Private Types
typedef CloudType::parcelType	parcelType
	Convenience typedef for parcel type. More...

Private Attributes
autoPtr< volScalarField >	thetaPtr_
	Void fraction field. More...

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Static Public Member Functions inherited from CloudFunctionObject< CloudType >
static autoPtr< CloudFunctionObject< CloudType > >	New (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	Selector. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
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

template<class CloudType>
class Foam::VoidFraction< CloudType >

Creates particle void fraction field on carrier phase.

Source files

Definition at line 50 of file VoidFraction.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType

private

Convenience typedef for parcel type.

Definition at line 59 of file VoidFraction.H.

Constructor & Destructor Documentation

◆ VoidFraction() [1/2]

VoidFraction	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	modelName
	)

Construct from dictionary.

Definition at line 49 of file VoidFraction.C.

◆ VoidFraction() [2/2]

VoidFraction ( const VoidFraction< CloudType > & vf )

Construct copy.

Definition at line 62 of file VoidFraction.C.

◆ ~VoidFraction()

~VoidFraction

virtual

Destructor.

Definition at line 74 of file VoidFraction.C.

Member Function Documentation

◆ write()

void write

protectedvirtual

Write post-processing info.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 31 of file VoidFraction.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "voidFraction" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 94 of file VoidFraction.H.

◆ preEvolve()

void preEvolve

virtual

Pre-evolve hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 81 of file VoidFraction.C.

References Foam::dimless, mesh, DSMCCloud< ParcelType >::mesh(), Foam::name(), and primitiveMesh::reset().

Here is the call graph for this function:

◆ postEvolve()

void postEvolve

virtual

Post-evolve hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 112 of file VoidFraction.C.

References GeometricField::internalField(), mesh, and DSMCCloud< ParcelType >::mesh().

Here is the call graph for this function:

◆ postMove()

void postMove	(	parcelType &	p,
		const label	cellI,
		const scalar	dt,
		const point &	position0,
		bool &	keepParticle
	)

virtual

Post-move hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 126 of file VoidFraction.C.

References p.

Field Documentation

◆ thetaPtr_

autoPtr<volScalarField> thetaPtr_

private

Void fraction field.

Definition at line 63 of file VoidFraction.H.

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

src/lagrangian/intermediate/submodels/CloudFunctionObjects/VoidFraction/VoidFraction.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/VoidFraction/VoidFraction.C

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::VoidFraction< CloudType >

Member Typedef Documentation

◆ parcelType

Constructor & Destructor Documentation

◆ VoidFraction() [1/2]

◆ VoidFraction() [2/2]

◆ ~VoidFraction()

Member Function Documentation

◆ write()

◆ TypeName()

◆ clone()

◆ preEvolve()

◆ postEvolve()

◆ postMove()

Field Documentation

◆ thetaPtr_

template<class CloudType>
class Foam::VoidFraction< CloudType >