Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
BreakupModel< CloudType > Class Template Referenceabstract

Templated break-up model class. More...

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

Public Member Functions

 TypeName ("breakupModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, BreakupModel, dictionary,( const dictionary &dict, CloudType &owner ),(dict, owner))
 Declare runtime constructor selection table. More...
 
 BreakupModel (CloudType &owner)
 Construct null from owner. More...
 
 BreakupModel (const dictionary &dict, CloudType &owner, const word &type, bool solveOscillationEq=false)
 Construct from dictionary. More...
 
 BreakupModel (const BreakupModel< CloudType > &bum)
 Construct copy. More...
 
virtual autoPtr< BreakupModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~BreakupModel ()
 Destructor. More...
 
const SwitchsolveOscillationEq () 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. 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 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< BreakupModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Protected Attributes

Switch solveOscillationEq_
 
scalar y0_
 
scalar yDot0_
 
scalar TABComega_
 
scalar TABCmu_
 
scalar TABtwoWeCrit_
 
- 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...
 

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...
 

Detailed Description

template<class CloudType>
class Foam::BreakupModel< CloudType >

Templated break-up model class.

Source files

Definition at line 50 of file SprayCloud.H.

Constructor & Destructor Documentation

BreakupModel ( CloudType owner)

Construct null from owner.

Definition at line 32 of file BreakupModel.C.

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

Here is the caller graph for this function:

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

Construct from dictionary.

Definition at line 64 of file BreakupModel.C.

References dictionary::lookup(), and readScalar.

Here is the call graph for this function:

BreakupModel ( const BreakupModel< CloudType > &  bum)

Construct copy.

Definition at line 48 of file BreakupModel.C.

References BreakupModel< CloudType >::BreakupModel().

Here is the call graph for this function:

~BreakupModel ( )
virtual

Destructor.

Definition at line 93 of file BreakupModel.C.

Member Function Documentation

TypeName ( "breakupModel"  )

Runtime type information.

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

Declare runtime constructor selection table.

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

Selector.

Definition at line 33 of file BreakupModelNew.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:

const Switch& solveOscillationEq ( ) const
inline

Definition at line 125 of file BreakupModel.H.

const scalar& y0 ( ) const
inline

Definition at line 130 of file BreakupModel.H.

const scalar& yDot0 ( ) const
inline

Definition at line 135 of file BreakupModel.H.

const scalar& TABComega ( ) const
inline

Definition at line 140 of file BreakupModel.H.

const scalar& TABCmu ( ) const
inline

Definition at line 145 of file BreakupModel.H.

const scalar& TABtwoWeCrit ( ) const
inline

Definition at line 150 of file BreakupModel.H.

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 SHF< CloudType >, TAB< CloudType >, PilchErdman< CloudType >, ETAB< CloudType >, ReitzDiwakar< CloudType >, ReitzKHRT< CloudType >, and NoBreakup< CloudType >.

Referenced by BreakupModel< Foam::SprayCloud< Foam::DSMCCloud > >::TABtwoWeCrit().

Here is the caller graph for this function:

Member Data Documentation

Switch solveOscillationEq_
protected
scalar y0_
protected
scalar yDot0_
protected
scalar TABComega_
protected
scalar TABCmu_
protected
scalar TABtwoWeCrit_
protected

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