TAB< CloudType > Class Template Reference

The TAB Method for Numerical Calculation of Spray Droplet Breakup. More...

Inheritance diagram for TAB< CloudType >:
Collaboration diagram for TAB< CloudType >:

Public Types

enum  SMDMethods { method1 , method2 }
 Enumeration for the SMD breakup calculation. More...
 
- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 

Public Member Functions

 TypeName ("TAB")
 Runtime type information. More...
 
 TAB (const dictionary &dict, CloudType &owner)
 Construct from dictionary. More...
 
 TAB (const TAB< CloudType > &im)
 Construct copy. More...
 
virtual autoPtr< BreakupModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~TAB ()
 Destructor. More...
 
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, const label injectori, scalar &dChild, scalar &massChild)
 Update the parcel diameter. More...
 
- Public Member Functions inherited from BreakupModel< CloudType >
 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 ~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
 
- 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)
 Copy constructor. More...
 
virtual ~CloudSubModelBase ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the owner cloud. More...
 
virtual bool writeTime () 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)
 Copy constructor. 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 void cacheFields (const bool store)
 Cache dependent 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...
 
void operator= (const subModelBase &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from BreakupModel< CloudType >
static autoPtr< BreakupModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. 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 BreakupModel< CloudType >
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...
 

Detailed Description

template<class CloudType>
class Foam::TAB< CloudType >

The TAB Method for Numerical Calculation of Spray Droplet Breakup.

    O'Rourke, P.J. and Amsden, A.A.,
    "The TAB Method for Numerical Calculation of Spray Droplet Breakup,"
    1987 SAE International Fuels and Lubricants Meeting and Exposition,
    Toronto, Ontario, November 2-5, 1987,
    Los Alamos National Laboratory document LA-UR-87-2105;
    SAE Technical Paper Series, Paper 872089.

This implementation follows the kiva version.

See also
The Enhanced TAB model - ETAB

Definition at line 60 of file TAB.H.

Member Enumeration Documentation

◆ SMDMethods

enum SMDMethods

Enumeration for the SMD breakup calculation.

Enumerator
method1 
method2 

Definition at line 67 of file TAB.H.

Constructor & Destructor Documentation

◆ TAB() [1/2]

TAB ( const dictionary dict,
CloudType owner 
)

Construct from dictionary.

Definition at line 31 of file TAB.C.

References Foam::endl(), Foam::exp(), forAll, TAB< CloudType >::method1, TAB< CloudType >::method2, n, Foam::pow3(), Foam::sqr(), and WarningInFunction.

Here is the call graph for this function:

◆ TAB() [2/2]

TAB ( const TAB< CloudType > &  im)

Construct copy.

Definition at line 71 of file TAB.C.

◆ ~TAB()

~TAB
virtual

Destructor.

Definition at line 81 of file TAB.C.

Member Function Documentation

◆ TypeName()

TypeName ( "TAB< CloudType >"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Implements BreakupModel< CloudType >.

Definition at line 104 of file TAB.H.

◆ update()

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,
const label  injectori,
scalar &  dChild,
scalar &  massChild 
)
virtual

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