Templated break-up model class. More...

#include <BreakupModel.H>

Inheritance diagram for BreakupModel< CloudType >:

[legend]

Collaboration diagram for BreakupModel< CloudType >:

Public Member Functions
	TypeName ("breakupModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, BreakupModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
	BreakupModel (CloudType &owner)
	Construct null from owner.
	BreakupModel (const dictionary &dict, CloudType &owner, const word &type, bool solveOscillationEq=false)
	Construct from dictionary.
	BreakupModel (const BreakupModel< CloudType > &bum)
	Construct copy.
virtual autoPtr< BreakupModel< CloudType > >	clone () const =0
	Construct and return a clone.
virtual	~BreakupModel ()
	Destructor.
bool	solveOscillationEq () const
const scalar &	y0 () const
const scalar &	yDot0 () const
const scalar &	TABComega () const
const scalar &	TABCmu () const
const scalar &	TABtwoWeCrit () const
virtual bool	update (const scalar dt, const vector &g, scalar &d, scalar &tc, scalar &ms, scalar &nParticle, scalar &KHindex, scalar &y, scalar &yDot, const scalar d0, const scalar rho, const scalar mu, const scalar sigma, const vector &U, const scalar rhoc, const scalar muc, const vector &Urel, const scalar Urmag, const scalar tMom, scalar &dChild, scalar &massChild)=0
	Update the parcel properties and return true if a child parcel.
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< BreakupModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.

Protected Attributes
bool	solveOscillationEq_
scalar	y0_
scalar	yDot0_
scalar	TABComega_
scalar	TABCmu_
scalar	TABtwoWeCrit_
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::BreakupModel< CloudType >

Templated break-up model class.

Source files

Definition at line 54 of file BreakupModel.H.

Constructor & Destructor Documentation

◆ BreakupModel() [1/3]

template<class CloudType>

BreakupModel ( CloudType & owner )

Construct null from owner.

Definition at line 27 of file BreakupModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), CloudSubModelBase< CloudType >::owner(), solveOscillationEq_, TABCmu_, TABComega_, TABtwoWeCrit_, y0_, and yDot0_.

Referenced by BreakupModel(), declareRunTimeSelectionTable(), ETAB< CloudType >::ETAB(), ETAB< CloudType >::ETAB(), NoBreakup< CloudType >::NoBreakup(), NoBreakup< CloudType >::NoBreakup(), PilchErdman< CloudType >::PilchErdman(), PilchErdman< CloudType >::PilchErdman(), ReitzDiwakar< CloudType >::ReitzDiwakar(), ReitzDiwakar< CloudType >::ReitzDiwakar(), ReitzKHRT< CloudType >::ReitzKHRT(), ReitzKHRT< CloudType >::ReitzKHRT(), SHF< CloudType >::SHF(), SHF< CloudType >::SHF(), TAB< CloudType >::TAB(), and TAB< CloudType >::TAB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BreakupModel() [2/3]

template<class CloudType>

BreakupModel	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	type,
		bool	solveOscillationEq = false )

Construct from dictionary.

Definition at line 59 of file BreakupModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), subModelBase::coeffDict(), subModelBase::dict(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, CloudSubModelBase< CloudType >::owner(), solveOscillationEq(), solveOscillationEq_, TABCmu_, TABComega_, TABtwoWeCrit_, y0_, and yDot0_.

Here is the call graph for this function:

◆ BreakupModel() [3/3]

template<class CloudType>

BreakupModel ( const BreakupModel< CloudType > & bum )

Construct copy.

Definition at line 43 of file BreakupModel.C.

References BreakupModel(), CloudSubModelBase< CloudType >::CloudSubModelBase(), solveOscillationEq_, TABCmu_, TABComega_, TABtwoWeCrit_, y0_, and yDot0_.

Here is the call graph for this function:

◆ ~BreakupModel()

template<class CloudType>

~BreakupModel ( )

virtual

Destructor.

Definition at line 90 of file BreakupModel.C.

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "breakupModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CloudType>

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

Declare runtime constructor selection table.

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

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

pure virtual

Construct and return a clone.

Implemented in ETAB< CloudType >, NoBreakup< CloudType >, PilchErdman< CloudType >, ReitzDiwakar< CloudType >, ReitzKHRT< CloudType >, SHF< CloudType >, and TAB< CloudType >.

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

Here is the call graph for this function:

◆ New()

template<class CloudType>

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

static

Selector.

Definition at line 28 of file BreakupModelNew.C.

References subModelBase::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, subModelBase::modelType(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ solveOscillationEq()

template<class CloudType>

bool solveOscillationEq ( ) const

inline

Definition at line 143 of file BreakupModel.H.

References solveOscillationEq_.

Referenced by BreakupModel(), and declareRunTimeSelectionTable().

Here is the caller graph for this function:

◆ y0()

template<class CloudType>

const scalar & y0 ( ) const

inline

Definition at line 148 of file BreakupModel.H.

References y0_.

◆ yDot0()

template<class CloudType>

const scalar & yDot0 ( ) const

inline

Definition at line 153 of file BreakupModel.H.

References yDot0_.

◆ TABComega()

template<class CloudType>

const scalar & TABComega ( ) const

inline

Definition at line 158 of file BreakupModel.H.

References TABComega_.

◆ TABCmu()

template<class CloudType>

const scalar & TABCmu ( ) const

inline

Definition at line 163 of file BreakupModel.H.

References TABCmu_.

◆ TABtwoWeCrit()

template<class CloudType>

const scalar & TABtwoWeCrit ( ) const

inline

Definition at line 168 of file BreakupModel.H.

References TABtwoWeCrit_.

◆ update()

template<class CloudType>

virtual bool update	(	const scalar	dt,
		const vector &	g,
		scalar &	d,
		scalar &	tc,
		scalar &	ms,
		scalar &	nParticle,
		scalar &	KHindex,
		scalar &	y,
		scalar &	yDot,
		const scalar	d0,
		const scalar	rho,
		const scalar	mu,
		const scalar	sigma,
		const vector &	U,
		const scalar	rhoc,
		const scalar	muc,
		const vector &	Urel,
		const scalar	Urmag,
		const scalar	tMom,
		scalar &	dChild,
		scalar &	massChild )

pure virtual

Update the parcel properties and return true if a child parcel.

should be added

Implemented in ETAB< CloudType >, NoBreakup< CloudType >, PilchErdman< CloudType >, ReitzDiwakar< CloudType >, ReitzKHRT< CloudType >, SHF< CloudType >, and TAB< CloudType >.

References g, mu, rho, sigma(), U, Urel, and y.

Here is the call graph for this function:

Member Data Documentation

◆ solveOscillationEq_

template<class CloudType>

bool solveOscillationEq_

protected

Definition at line 63 of file BreakupModel.H.

Referenced by BreakupModel(), BreakupModel(), BreakupModel(), and solveOscillationEq().

◆ y0_

template<class CloudType>

scalar y0_

protected

Definition at line 65 of file BreakupModel.H.

Referenced by BreakupModel(), BreakupModel(), BreakupModel(), and y0().

◆ yDot0_

template<class CloudType>

scalar yDot0_

protected

Definition at line 66 of file BreakupModel.H.

Referenced by BreakupModel(), BreakupModel(), BreakupModel(), and yDot0().

◆ TABComega_

template<class CloudType>

scalar TABComega_

protected

Definition at line 68 of file BreakupModel.H.

Referenced by BreakupModel(), BreakupModel(), BreakupModel(), TABComega(), ETAB< CloudType >::update(), and TAB< CloudType >::update().

◆ TABCmu_

template<class CloudType>

scalar TABCmu_

protected

Definition at line 69 of file BreakupModel.H.

Referenced by BreakupModel(), BreakupModel(), BreakupModel(), TABCmu(), ETAB< CloudType >::update(), and TAB< CloudType >::update().

◆ TABtwoWeCrit_

template<class CloudType>

scalar TABtwoWeCrit_

protected

Definition at line 70 of file BreakupModel.H.

Referenced by BreakupModel(), BreakupModel(), BreakupModel(), TABtwoWeCrit(), ETAB< CloudType >::update(), and TAB< CloudType >::update().

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

src/lagrangian/spray/clouds/Templates/SprayCloud/SprayCloud.H
src/lagrangian/spray/submodels/BreakupModel/BreakupModel/BreakupModel.H
src/lagrangian/spray/submodels/BreakupModel/BreakupModel/BreakupModel.C
src/lagrangian/spray/submodels/BreakupModel/BreakupModel/BreakupModelNew.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BreakupModel() [1/3]

◆ BreakupModel() [2/3]

◆ BreakupModel() [3/3]

◆ ~BreakupModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ solveOscillationEq()

◆ y0()

◆ yDot0()

◆ TABComega()

◆ TABCmu()

◆ TABtwoWeCrit()

◆ update()

Member Data Documentation

◆ solveOscillationEq_

◆ y0_

◆ yDot0_

◆ TABComega_

◆ TABCmu_

◆ TABtwoWeCrit_