Public Types | Public Member Functions | Protected Attributes | List of all members
CloudSubModelBase< CloudType > Class Template Reference

Base class for cloud sub-models. More...

Inherits subModelBase.

Inherited by AtomizationModel< Foam::SprayCloud< Foam::DSMCCloud > >, BreakupModel< Foam::SprayCloud< Foam::DSMCCloud > >, CloudFunctionObject< KinematicCloud< Foam::DSMCCloud > >, CloudFunctionObject< KinematicCloud< CloudType > >, CloudFunctionObject< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >, CollisionModel< Foam::CollidingCloud< Foam::DSMCCloud > >, CompositionModel< Foam::ReactingCloud< Foam::DSMCCloud > >, DampingModel< Foam::KinematicCloud< Foam::DSMCCloud > >, DampingModel< Foam::MPPICCloud< Foam::DSMCCloud > >, DevolatilisationModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >, DispersionModel< Foam::KinematicCloud< Foam::DSMCCloud > >, HeatTransferModel< Foam::ThermoCloud< Foam::DSMCCloud > >, HeterogeneousReactingModel< Foam::ReactingHeterogeneousCloud< Foam::DSMCCloud > >, InjectionModel< Foam::KinematicCloud< Foam::DSMCCloud > >, IsotropyModel< Foam::KinematicCloud< Foam::DSMCCloud > >, IsotropyModel< Foam::MPPICCloud< Foam::DSMCCloud > >, PackingModel< Foam::KinematicCloud< Foam::DSMCCloud > >, PackingModel< Foam::MPPICCloud< Foam::DSMCCloud > >, PatchInteractionModel< Foam::KinematicCloud< Foam::DSMCCloud > >, PatchInteractionModel< Foam::DSMCCloud >, PhaseChangeModel< Foam::ReactingCloud< Foam::DSMCCloud > >, StochasticCollisionModel< Foam::KinematicCloud< Foam::DSMCCloud > >, SurfaceFilmModel< Foam::KinematicCloud< Foam::DSMCCloud > >, SurfaceReactionModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >, AtomizationModel< CloudType >, BreakupModel< CloudType >, CloudFunctionObject< CloudType >, CollisionModel< CloudType >, CompositionModel< CloudType >, DampingModel< CloudType >, DevolatilisationModel< CloudType >, DispersionModel< CloudType >, HeatTransferModel< CloudType >, HeterogeneousReactingModel< CloudType >, InjectionModel< CloudType >, IsotropyModel< CloudType >, PackingModel< CloudType >, PatchInteractionModel< CloudType >, PhaseChangeModel< CloudType >, StochasticCollisionModel< CloudType >, SurfaceFilmModel< CloudType >, and SurfaceReactionModel< CloudType >.

Collaboration diagram for CloudSubModelBase< CloudType >:
[legend]

Public Types

typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 

Public Member Functions

 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 CloudType & owner () const
 Return const access to the owner cloud. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
CloudType & owner ()
 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 word & modelName () const
 Return const access to the name of the sub-model. More...
 
const dictionary & dict () const
 Return const access to the cloud dictionary. More...
 
const word & baseName () const
 Return const access to the base name of the sub-model. More...
 
const word & modelType () const
 Return const access to the sub-model type. More...
 
const dictionary & coeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionary & properties () 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 dependent sub-model fields. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=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...
 
bool getModelDict (const word &entryName, dictionary &dict) const
 Retrieve dictionary, return true if set. More...
 
template<class Type >
bool 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=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...
 
virtual void write (Ostream &os) const
 Write. More...
 

Protected Attributes

CloudType & owner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionary & properties_
 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

- 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::CloudSubModelBase< CloudType >

Base class for cloud sub-models.

Source files

Definition at line 51 of file CloudSubModelBase.H.

Member Typedef Documentation

◆ cloudType

typedef CloudType cloudType

Type of cloud this model was instantiated for.

Definition at line 98 of file CloudSubModelBase.H.

Constructor & Destructor Documentation

◆ CloudSubModelBase() [1/4]

CloudSubModelBase ( CloudType &  owner)

Construct null from owner cloud.

Definition at line 34 of file CloudSubModelBase.C.

◆ CloudSubModelBase() [2/4]

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

Construct from owner cloud without name.

Definition at line 42 of file CloudSubModelBase.C.

◆ CloudSubModelBase() [3/4]

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

Construct from owner cloud with name.

Definition at line 64 of file CloudSubModelBase.C.

◆ CloudSubModelBase() [4/4]

CloudSubModelBase ( const CloudSubModelBase< CloudType > &  smb)

Construct as copy.

Definition at line 86 of file CloudSubModelBase.C.

◆ ~CloudSubModelBase()

~CloudSubModelBase
virtual

Destructor.

Definition at line 99 of file CloudSubModelBase.C.

Member Function Documentation

◆ owner() [1/2]

const CloudType & owner

Return const access to the owner cloud.

Definition at line 106 of file CloudSubModelBase.C.

Referenced by CloudFunctionObject< CloudType >::CloudFunctionObject(), ConeInjection< CloudType >::ConeInjection(), ConeNozzleInjection< CloudType >::ConeNozzleInjection(), ConstantRateDevolatilisation< CloudType >::ConstantRateDevolatilisation(), COxidationDiffusionLimitedRate< CloudType >::COxidationDiffusionLimitedRate(), COxidationHurtMitchell< CloudType >::COxidationHurtMitchell(), COxidationIntrinsicRate< CloudType >::COxidationIntrinsicRate(), COxidationKineticDiffusionLimitedRate< CloudType >::COxidationKineticDiffusionLimitedRate(), COxidationMurphyShaddix< CloudType >::COxidationMurphyShaddix(), FaceInteraction< CloudType >::FaceInteraction(), FacePostProcessing< CloudType >::FacePostProcessing(), Implicit< CloudType >::Implicit(), InflationInjection< CloudType >::InflationInjection(), InjectedParticleDistributionInjection< CloudType >::InjectedParticleDistributionInjection(), InjectedParticleInjection< CloudType >::InjectedParticleInjection(), KinematicLookupTableInjection< CloudType >::KinematicLookupTableInjection(), LiquidEvapFuchsKnudsen< CloudType >::LiquidEvapFuchsKnudsen(), LiquidEvaporation< CloudType >::LiquidEvaporation(), LiquidEvaporationBoil< CloudType >::LiquidEvaporationBoil(), LocalInteraction< CloudType >::LocalInteraction(), MUCSheterogeneousRate< CloudType >::MUCSheterogeneousRate(), ParticleErosion< CloudType >::ParticleErosion(), ParticleZoneInfo< CloudType >::ParticleZoneInfo(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), PatchFlowRateInjection< CloudType >::PatchFlowRateInjection(), PatchInjection< CloudType >::PatchInjection(), PatchParticleHistogram< CloudType >::PatchParticleHistogram(), PatchPostProcessing< CloudType >::PatchPostProcessing(), ReactingLookupTableInjection< CloudType >::ReactingLookupTableInjection(), ReactingMultiphaseLookupTableInjection< CloudType >::ReactingMultiphaseLookupTableInjection(), RemoveParcels< CloudType >::RemoveParcels(), SingleKineticRateDevolatilisation< CloudType >::SingleKineticRateDevolatilisation(), and ThermoLookupTableInjection< CloudType >::ThermoLookupTableInjection().

Here is the caller graph for this function:

◆ writeTime()

bool writeTime
virtual

Flag to indicate when to write a property.

Reimplemented from subModelBase.

Definition at line 120 of file CloudSubModelBase.C.

◆ localPath()

Foam::fileName localPath
virtual

Output directory.

Reimplemented from subModelBase.

Definition at line 130 of file CloudSubModelBase.C.

References cloud::prefix.

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

Here is the caller graph for this function:

◆ owner() [2/2]

CloudType & owner

Return non-const access to the owner cloud for manipulation.

Definition at line 113 of file CloudSubModelBase.C.

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Reimplemented from subModelBase.

Reimplemented in DispersionRASModel< CloudType >.

Definition at line 142 of file CloudSubModelBase.C.

References os(), ObukhovLength::write(), and Ostream::writeEntry().

Here is the call graph for this function:

Member Data Documentation

◆ owner_

CloudType& owner_
protected

Reference to the cloud.

Definition at line 60 of file CloudSubModelBase.H.

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