Public Member Functions | Static Public Member Functions | List of all members
AtomizationModel< CloudType > Class Template Referenceabstract

Templated atomization model class. More...

Inheritance diagram for AtomizationModel< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for AtomizationModel< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("atomizationModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, AtomizationModel, dictionary,( const dictionary &dict, CloudType &owner ),(dict, owner))
 Declare runtime constructor selection table. More...
 
 AtomizationModel (CloudType &owner)
 Construct null from owner. More...
 
 AtomizationModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from dictionary. More...
 
 AtomizationModel (const AtomizationModel< CloudType > &am)
 Construct copy. More...
 
virtual autoPtr< AtomizationModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~AtomizationModel ()
 Destructor. More...
 
scalar Taverage (const scalar &Tliq, const scalar &Tc) const
 Average temperature calculation. More...
 
virtual scalar initLiquidCore () const =0
 Initial value of liquidCore. More...
 
virtual bool calcChi () const =0
 Flag to indicate if chi needs to be calculated. More...
 
virtual void update (const scalar dt, scalar &d, scalar &liquidCore, scalar &tc, const scalar rho, const scalar mu, const scalar sigma, const scalar volFlowRate, const scalar rhoAv, const scalar Urel, const vector &pos, const vector &injectionPos, const scalar pAmbient, const scalar chi, cachedRandom &rndGen) const =0
 
- 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 CloudTypeowner () const
 Return const access to the owner cloud. More...
 
virtual bool outputTime () const
 Flag to indicate when to write a property. More...
 
CloudTypeowner ()
 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 wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () 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...
 

Static Public Member Functions

static autoPtr< AtomizationModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 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::AtomizationModel< CloudType >

Templated atomization model class.

Source files

Definition at line 47 of file SprayCloud.H.

Constructor & Destructor Documentation

Construct null from owner.

Definition at line 32 of file AtomizationModel.C.

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

Here is the caller graph for this function:

AtomizationModel ( const dictionary dict,
CloudType owner,
const word type 
)

Construct from dictionary.

Definition at line 52 of file AtomizationModel.C.

Construct copy.

Definition at line 42 of file AtomizationModel.C.

References AtomizationModel< CloudType >::AtomizationModel().

Here is the call graph for this function:

~AtomizationModel ( )
virtual

Destructor.

Definition at line 65 of file AtomizationModel.C.

References AtomizationModel< CloudType >::Taverage().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "atomizationModel"  )

Runtime type information.

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

Declare runtime constructor selection table.

virtual autoPtr<AtomizationModel<CloudType> > clone ( ) const
pure virtual
Foam::autoPtr< Foam::AtomizationModel< CloudType > > New ( const dictionary dict,
CloudType owner 
)
static

Selector.

Definition at line 33 of file AtomizationModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

Foam::scalar Taverage ( const scalar &  Tliq,
const scalar &  Tc 
) const

Average temperature calculation.

Definition at line 73 of file AtomizationModel.C.

Referenced by SprayParcel< ParcelType >::calcAtomization(), and AtomizationModel< CloudType >::~AtomizationModel().

Here is the caller graph for this function:

virtual scalar initLiquidCore ( ) const
pure virtual
virtual bool calcChi ( ) const
pure virtual

Flag to indicate if chi needs to be calculated.

Implemented in LISAAtomization< CloudType >, BlobsSheetAtomization< CloudType >, and NoAtomization< CloudType >.

Referenced by SprayParcel< ParcelType >::calcAtomization().

Here is the caller graph for this function:

virtual void update ( const scalar  dt,
scalar &  d,
scalar &  liquidCore,
scalar &  tc,
const scalar  rho,
const scalar  mu,
const scalar  sigma,
const scalar  volFlowRate,
const scalar  rhoAv,
const scalar  Urel,
const vector pos,
const vector injectionPos,
const scalar  pAmbient,
const scalar  chi,
cachedRandom rndGen 
) const
pure virtual

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