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

Inheritance diagram for VoidFraction< CloudType >:

Collaboration diagram for VoidFraction< CloudType >:

Public Member Functions
	TypeName ("voidFraction")

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

	VoidFraction (const VoidFraction< CloudType > &vf)

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

virtual	~VoidFraction ()=default

virtual void	preEvolve (const typename parcelType::trackingData &td)

virtual void	postEvolve (const typename parcelType::trackingData &td)

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

Public Member Functions inherited from CloudFunctionObject< CloudType >
	TypeName ("cloudFunctionObject")

	declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))

	CloudFunctionObject (CloudType &owner)

	CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)

	CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)

virtual	~CloudFunctionObject ()=default

virtual void	postPatch (const parcelType &p, const polyPatch &pp, bool &keepParticle)

virtual void	postFace (const parcelType &p, bool &keepParticle)

const fileName &	outputDir () const

fileName	writeTimeDir () const

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)

virtual	~CloudSubModelBase ()

const CloudType &	owner () const

virtual bool	writeTime () const

virtual fileName	localPath () const

CloudType &	owner ()

virtual void	write (Ostream &os) const

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)

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

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

	subModelBase (const subModelBase &smb)

virtual	~subModelBase ()

const word &	modelName () const

const dictionary &	dict () const

const word &	baseName () const

const word &	modelType () const

const dictionary &	coeffDict () const

const dictionary &	properties () const

virtual bool	defaultCoeffs (const bool printMsg) const

virtual bool	active () const

virtual void	cacheFields (const bool store)

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)

bool	getModelDict (const word &entryName, dictionary &dict) const

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)

Protected Member Functions
virtual void	write ()

Protected Member Functions inherited from subModelBase
bool	inLine () const

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType

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

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_

Protected Attributes inherited from subModelBase
const word	modelName_

dictionary &	properties_

const dictionary	dict_

const word	baseName_

const word	modelType_

const dictionary	coeffDict_

Detailed Description

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

Creates particle void fraction field on carrier phase.

Source files

Definition at line 52 of file VoidFraction.H.

Constructor & Destructor Documentation

◆ VoidFraction() [1/2]

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

Definition at line 45 of file VoidFraction.C.

◆ VoidFraction() [2/2]

VoidFraction ( const VoidFraction< CloudType > & vf )

Definition at line 58 of file VoidFraction.C.

◆ ~VoidFraction()

virtual ~VoidFraction ( )

virtualdefault

Member Function Documentation

◆ write()

void write

protectedvirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 27 of file VoidFraction.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "voidFraction" )

◆ clone()

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

inlinevirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 96 of file VoidFraction.H.

◆ preEvolve()

void preEvolve ( const typename parcelType::trackingData & td )

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 71 of file VoidFraction.C.

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

Here is the call graph for this function:

◆ postEvolve()

void postEvolve ( const typename parcelType::trackingData & td )

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 105 of file VoidFraction.C.

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

Here is the call graph for this function:

◆ postMove()

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

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 121 of file VoidFraction.C.

References p.

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

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ VoidFraction() [1/2]

◆ VoidFraction() [2/2]

◆ ~VoidFraction()

Member Function Documentation

◆ write()

◆ TypeName()

◆ clone()

◆ preEvolve()

◆ postEvolve()

◆ postMove()

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