Loading...
Searching...
No Matches
subModelBase Class Reference

Base class for generic sub-models requiring to be read from dictionary. Provides a mechanism to read and write properties from a dictionary to enable clean re-starts. Used by, e.g. clou dsub-models. More...

#include <subModelBase.H>

Inheritance diagram for subModelBase:
Collaboration diagram for subModelBase:

Public Member Functions

 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 wordmodelName () const
 Return const access to the name of the sub-model.
const dictionarydict () const
 Return const access to the cloud dictionary.
const wordbaseName () const
 Return const access to the base name of the sub-model.
const wordmodelType () const
 Return const access to the sub-model type.
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary.
const dictionaryproperties () 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.
virtual bool writeTime () const
 Flag to indicate when to write a property.
virtual fileName localPath () const
 Output directory.
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.
virtual void write (Ostream &os) const
 Write.

Public Attributes

bool log
 Flag to write log into Info.

Protected Member Functions

bool inLine () const
 Flag to indicate whether data is/was read in-line.

Protected Attributes

const word modelName_
 Name of the sub-model.
dictionaryproperties_
 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.

Detailed Description

Base class for generic sub-models requiring to be read from dictionary. Provides a mechanism to read and write properties from a dictionary to enable clean re-starts. Used by, e.g. clou dsub-models.

Source files

Definition at line 50 of file subModelBase.H.

Constructor & Destructor Documentation

◆ subModelBase() [1/4]

◆ subModelBase() [2/4]

subModelBase ( dictionary & properties,
const dictionary & dict,
const word & baseName,
const word & modelType,
const word & dictExt = "Coeffs" )

Construct from components without name.

Definition at line 46 of file subModelBase.C.

References baseName(), baseName_, coeffDict_, dict(), dict_, log, modelName_, modelType(), modelType_, properties(), and properties_.

Here is the call graph for this function:

◆ subModelBase() [3/4]

subModelBase ( const word & modelName,
dictionary & properties,
const dictionary & dict,
const word & baseName,
const word & modelType )

Construct from components with name.

Definition at line 65 of file subModelBase.C.

References baseName(), baseName_, coeffDict_, dict(), dict_, log, modelName(), modelName_, modelType(), modelType_, properties(), and properties_.

Here is the call graph for this function:

◆ subModelBase() [4/4]

subModelBase ( const subModelBase & smb)

Construct as copy.

Definition at line 84 of file subModelBase.C.

References baseName_, coeffDict_, dict_, log, modelName_, modelType_, properties_, and subModelBase().

Here is the call graph for this function:

◆ ~subModelBase()

virtual ~subModelBase ( )
virtualdefault

Destructor.

References dict(), os(), and Foam::Zero.

Here is the call graph for this function:

Member Function Documentation

◆ inLine()

bool inLine ( ) const
protected

Flag to indicate whether data is/was read in-line.

Referenced by getModelDict(), getModelProperty(), and setModelProperty().

Here is the caller graph for this function:

◆ modelName()

const Foam::word & modelName ( ) const

Return const access to the name of the sub-model.

Definition at line 98 of file subModelBase.C.

References modelName_.

Referenced by CellZoneInjection< CloudType >::CellZoneInjection(), PatchInteractionFields< CloudType >::clearOrReset(), CloudFunctionObject< CloudType >::CloudFunctionObject(), CloudSubModelBase< CloudType >::CloudSubModelBase(), CloudSubModelBase< Foam::CollidingCloud< Foam::DSMCCloud< dsmcParcel > > >::CloudSubModelBase(), ConeInjection< CloudType >::ConeInjection(), ConeNozzleInjection< CloudType >::ConeNozzleInjection(), CloudFunctionObject< CloudType >::declareRunTimeSelectionTable(), InjectionModel< CloudType >::declareRunTimeSelectionTable(), FaceInteraction< CloudType >::FaceInteraction(), FacePostProcessing< CloudType >::FacePostProcessing(), FieldActivatedInjection< CloudType >::FieldActivatedInjection(), filmSubModelBase::filmSubModelBase(), filmSubModelBase::filmSubModelBase(), FreezeParticles< CloudType >::FreezeParticles(), HeatTransferCoeff< CloudType >::HeatTransferCoeff(), InflationInjection< CloudType >::InflationInjection(), InjectionModel< CloudType >::info(), InjectedParticleDistributionInjection< CloudType >::InjectedParticleDistributionInjection(), InjectedParticleInjection< CloudType >::InjectedParticleInjection(), InjectionModel< CloudType >::InjectionModel(), KinematicLookupTableInjection< CloudType >::KinematicLookupTableInjection(), KinematicReynoldsNumber< CloudType >::KinematicReynoldsNumber(), KinematicWeberNumber< CloudType >::KinematicWeberNumber(), ManualInjection< CloudType >::ManualInjection(), CloudFunctionObject< CloudType >::New(), InjectionModel< CloudType >::New(), NusseltNumber< CloudType >::NusseltNumber(), HeatTransferCoeff< CloudType >::operator=(), KinematicReynoldsNumber< CloudType >::operator=(), KinematicWeberNumber< CloudType >::operator=(), NusseltNumber< CloudType >::operator=(), ParticleDose< CloudType >::operator=(), ThermoReynoldsNumber< CloudType >::operator=(), ORourkeCollision< CloudType >::ORourkeCollision(), ParticleCollector< CloudType >::ParticleCollector(), ParticleDose< CloudType >::ParticleDose(), ParticleErosion< CloudType >::ParticleErosion(), ParticleHistogram< CloudType >::ParticleHistogram(), ParticlePostProcessing< CloudType >::ParticlePostProcessing(), ParticleTracks< CloudType >::ParticleTracks(), ParticleTrap< CloudType >::ParticleTrap(), ParticleZoneInfo< CloudType >::ParticleZoneInfo(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), PatchFlowRateInjection< CloudType >::PatchFlowRateInjection(), PatchInjection< CloudType >::PatchInjection(), PatchInteractionFields< CloudType >::PatchInteractionFields(), RemoveParcels< CloudType >::postEvolve(), ReactingLookupTableInjection< CloudType >::ReactingLookupTableInjection(), ReactingMultiphaseLookupTableInjection< CloudType >::ReactingMultiphaseLookupTableInjection(), ReactingWeberNumber< CloudType >::ReactingWeberNumber(), RemoveParcels< CloudType >::RemoveParcels(), InjectionModel< Foam::KinematicCloud< Foam::DSMCCloud< dsmcParcel > > >::setNumberOfParticles(), subModelBase(), ThermoLookupTableInjection< CloudType >::ThermoLookupTableInjection(), ThermoReynoldsNumber< CloudType >::ThermoReynoldsNumber(), CellZoneInjection< CloudType >::TypeName(), ConeInjection< CloudType >::TypeName(), ConeNozzleInjection< CloudType >::TypeName(), FaceInteraction< CloudType >::TypeName(), FacePostProcessing< CloudType >::TypeName(), FieldActivatedInjection< CloudType >::TypeName(), FreezeParticles< CloudType >::TypeName(), InflationInjection< CloudType >::TypeName(), InjectedParticleDistributionInjection< CloudType >::TypeName(), InjectedParticleInjection< CloudType >::TypeName(), KinematicLookupTableInjection< CloudType >::TypeName(), ManualInjection< CloudType >::TypeName(), ORourkeCollision< CloudType >::TypeName(), ParticleCollector< CloudType >::TypeName(), ParticleErosion< CloudType >::TypeName(), ParticleHistogram< CloudType >::TypeName(), ParticlePostProcessing< CloudType >::TypeName(), ParticleTracks< CloudType >::TypeName(), ParticleTrap< CloudType >::TypeName(), ParticleZoneInfo< CloudType >::TypeName(), PatchCollisionDensity< CloudType >::TypeName(), PatchFlowRateInjection< CloudType >::TypeName(), PatchInjection< CloudType >::TypeName(), PatchInteractionFields< CloudType >::TypeName(), ReactingLookupTableInjection< CloudType >::TypeName(), ReactingMultiphaseLookupTableInjection< CloudType >::TypeName(), ReactingWeberNumber< CloudType >::TypeName(), RemoveParcels< CloudType >::TypeName(), ThermoLookupTableInjection< CloudType >::TypeName(), VoidFraction< CloudType >::TypeName(), VoidFraction< CloudType >::VoidFraction(), CloudFunctionObject< CloudType >::~CloudFunctionObject(), and InjectionModel< CloudType >::~InjectionModel().

◆ dict()

const Foam::dictionary & dict ( ) const

Return const access to the cloud dictionary.

Definition at line 104 of file subModelBase.C.

References dict_.

Referenced by ArrheniusViscosity::ArrheniusViscosity(), AtomizationModel< CloudType >::AtomizationModel(), BlobsSheetAtomization< CloudType >::BlobsSheetAtomization(), BreakupModel< CloudType >::BreakupModel(), BrunDrippingInjection::BrunDrippingInjection(), BrunDrippingInjection::BrunDrippingInjection(), CellZoneInjection< CloudType >::CellZoneInjection(), AtomizationModel< CloudType >::clone(), BreakupModel< CloudType >::clone(), CollisionModel< CloudType >::clone(), CompositionModel< CloudType >::clone(), DampingModel< CloudType >::clone(), DevolatilisationModel< CloudType >::clone(), DispersionModel< CloudType >::clone(), IsotropyModel< CloudType >::clone(), PackingModel< CloudType >::clone(), StochasticCollisionModel< CloudType >::clone(), CloudFunctionObject< CloudType >::CloudFunctionObject(), CloudSubModelBase< CloudType >::CloudSubModelBase(), CloudSubModelBase< CloudType >::CloudSubModelBase(), CloudSubModelBase< Foam::CollidingCloud< Foam::DSMCCloud< dsmcParcel > > >::CloudSubModelBase(), CollisionModel< CloudType >::CollisionModel(), CompositionModel< CloudType >::CompositionModel(), ConeInjection< CloudType >::ConeInjection(), ConeNozzleInjection< CloudType >::ConeNozzleInjection(), constantFilmThermo::constantFilmThermo(), constantHeatTransfer::constantHeatTransfer(), constantRadiation::constantRadiation(), ConstantRateDevolatilisation< CloudType >::ConstantRateDevolatilisation(), constantViscosity::constantViscosity(), contactAngleForce::contactAngleForce(), contactAngleForce::contactAngleForce(), COxidationDiffusionLimitedRate< CloudType >::COxidationDiffusionLimitedRate(), COxidationHurtMitchell< CloudType >::COxidationHurtMitchell(), COxidationIntrinsicRate< CloudType >::COxidationIntrinsicRate(), COxidationKineticDiffusionLimitedRate< CloudType >::COxidationKineticDiffusionLimitedRate(), COxidationMurphyShaddix< CloudType >::COxidationMurphyShaddix(), curvatureSeparation::curvatureSeparation(), DampingModel< CloudType >::DampingModel(), AtomizationModel< CloudType >::declareRunTimeSelectionTable(), BreakupModel< CloudType >::declareRunTimeSelectionTable(), CloudFunctionObject< CloudType >::declareRunTimeSelectionTable(), CollisionModel< CloudType >::declareRunTimeSelectionTable(), CompositionModel< CloudType >::declareRunTimeSelectionTable(), DampingModel< CloudType >::declareRunTimeSelectionTable(), DevolatilisationModel< CloudType >::declareRunTimeSelectionTable(), DispersionModel< CloudType >::declareRunTimeSelectionTable(), HeatTransferModel< CloudType >::declareRunTimeSelectionTable(), HeterogeneousReactingModel< CloudType >::declareRunTimeSelectionTable(), InjectionModel< CloudType >::declareRunTimeSelectionTable(), IsotropyModel< CloudType >::declareRunTimeSelectionTable(), PackingModel< CloudType >::declareRunTimeSelectionTable(), PatchInteractionModel< CloudType >::declareRunTimeSelectionTable(), PhaseChangeModel< CloudType >::declareRunTimeSelectionTable(), force::declareRunTimeSelectionTable(), injectionModel::declareRunTimeSelectionTable(), filmRadiationModel::declareRunTimeSelectionTable(), filmThermoModel::declareRunTimeSelectionTable(), filmTurbulenceModel::declareRunTimeSelectionTable(), filmViscosityModel::declareRunTimeSelectionTable(), force::declareRunTimeSelectionTable(), heatTransferModel::declareRunTimeSelectionTable(), injectionModel::declareRunTimeSelectionTable(), phaseChangeModel::declareRunTimeSelectionTable(), transferModel::declareRunTimeSelectionTable(), StochasticCollisionModel< CloudType >::declareRunTimeSelectionTable(), SurfaceFilmModel< CloudType >::declareRunTimeSelectionTable(), SurfaceReactionModel< CloudType >::declareRunTimeSelectionTable(), DevolatilisationModel< CloudType >::DevolatilisationModel(), DispersionModel< CloudType >::DispersionModel(), distributionContactAngleForce::distributionContactAngleForce(), drippingInjection::drippingInjection(), dynamicContactAngleForce::dynamicContactAngleForce(), ETAB< CloudType >::ETAB(), Explicit< CloudType >::Explicit(), FaceInteraction< CloudType >::FaceInteraction(), FacePostProcessing< CloudType >::FacePostProcessing(), FieldActivatedInjection< CloudType >::FieldActivatedInjection(), filmRadiationModel::filmRadiationModel(), filmSeparation::filmSeparation(), filmSubModelBase::filmSubModelBase(), filmSubModelBase::filmSubModelBase(), filmSubModelBase::filmSubModelBase(), filmSubModelBase::filmSubModelBase(), filmThermoModel::filmThermoModel(), filmTurbulenceModel::filmTurbulenceModel(), filmViscosityModel::filmViscosityModel(), force::force(), force::force(), FreezeParticles< CloudType >::FreezeParticles(), function1Viscosity::function1Viscosity(), getModelDict(), HeatTransferCoeff< CloudType >::HeatTransferCoeff(), HeatTransferModel< CloudType >::HeatTransferModel(), heatTransferModel::heatTransferModel(), HeterogeneousReactingModel< CloudType >::HeterogeneousReactingModel(), Implicit< CloudType >::Implicit(), InflationInjection< CloudType >::InflationInjection(), InjectedParticleDistributionInjection< CloudType >::info(), liquidFilmThermo::initLiquid(), InjectedParticleDistributionInjection< CloudType >::InjectedParticleDistributionInjection(), InjectedParticleInjection< CloudType >::InjectedParticleInjection(), InjectionModel< CloudType >::InjectionModel(), injectionModel::injectionModel(), injectionModel::injectionModel(), injectionModelList::injectionModelList(), injectionModelList::injectionModelList(), IsotropyModel< CloudType >::IsotropyModel(), KinematicLookupTableInjection< CloudType >::KinematicLookupTableInjection(), KinematicReynoldsNumber< CloudType >::KinematicReynoldsNumber(), KinematicSurfaceFilm< CloudType >::KinematicSurfaceFilm(), KinematicWeberNumber< CloudType >::KinematicWeberNumber(), laminar::laminar(), LiquidEvapFuchsKnudsen< CloudType >::LiquidEvapFuchsKnudsen(), LiquidEvaporation< CloudType >::LiquidEvaporation(), LiquidEvaporationBoil< CloudType >::LiquidEvaporationBoil(), liquidFilmThermo::liquidFilmThermo(), liquidViscosity::liquidViscosity(), LISAAtomization< CloudType >::LISAAtomization(), LocalInteraction< CloudType >::LocalInteraction(), ManualInjection< CloudType >::ManualInjection(), mappedConvectiveHeatTransfer::mappedConvectiveHeatTransfer(), MUCSheterogeneousRate< CloudType >::MUCSheterogeneousRate(), MultiInteraction< CloudType >::MultiInteraction(), AtomizationModel< CloudType >::New(), BreakupModel< CloudType >::New(), CloudFunctionObject< CloudType >::New(), CollisionModel< CloudType >::New(), CompositionModel< CloudType >::New(), DampingModel< CloudType >::New(), DevolatilisationModel< CloudType >::New(), DispersionModel< CloudType >::New(), HeatTransferModel< CloudType >::New(), HeterogeneousReactingModel< CloudType >::New(), InjectionModel< CloudType >::New(), InjectionModel< CloudType >::New(), IsotropyModel< CloudType >::New(), PackingModel< CloudType >::New(), PatchInteractionModel< CloudType >::New(), PhaseChangeModel< CloudType >::New(), force::New(), injectionModel::New(), filmRadiationModel::New(), filmThermoModel::New(), filmTurbulenceModel::New(), filmViscosityModel::New(), force::New(), heatTransferModel::New(), injectionModel::New(), phaseChangeModel::New(), transferModel::New(), StochasticCollisionModel< CloudType >::New(), SurfaceFilmModel< CloudType >::New(), SurfaceReactionModel< CloudType >::New(), NoAtomization< CloudType >::NoAtomization(), NoCollision< CloudType >::NoCollision(), NoDamping< CloudType >::NoDamping(), NoIsotropy< CloudType >::NoIsotropy(), NoPacking< CloudType >::NoPacking(), noRadiation::noRadiation(), NoStochasticCollision< CloudType >::NoStochasticCollision(), NusseltNumber< CloudType >::NusseltNumber(), HeatTransferCoeff< CloudType >::operator=(), HeatTransferModel< CloudType >::operator=(), KinematicReynoldsNumber< CloudType >::operator=(), KinematicWeberNumber< CloudType >::operator=(), NusseltNumber< CloudType >::operator=(), ParticleDose< CloudType >::operator=(), RanzMarshall< CloudType >::operator=(), ThermoReynoldsNumber< CloudType >::operator=(), ORourkeCollision< CloudType >::ORourkeCollision(), PackingModel< CloudType >::PackingModel(), PairCollision< CloudType >::PairCollision(), ParticleCollector< CloudType >::ParticleCollector(), ParticleDose< CloudType >::ParticleDose(), ParticleErosion< CloudType >::ParticleErosion(), ParticleHistogram< CloudType >::ParticleHistogram(), ParticlePostProcessing< CloudType >::ParticlePostProcessing(), ParticleTracks< CloudType >::ParticleTracks(), ParticleTrap< CloudType >::ParticleTrap(), ParticleZoneInfo< CloudType >::ParticleZoneInfo(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), PatchFlowRateInjection< CloudType >::PatchFlowRateInjection(), PatchInjection< CloudType >::PatchInjection(), patchInjection::patchInjection(), PatchInteractionFields< CloudType >::PatchInteractionFields(), PatchInteractionModel< CloudType >::PatchInteractionModel(), PatchInteractionModel< Foam::KinematicCloud< Foam::DSMCCloud< dsmcParcel > > >::PatchInteractionModel(), perturbedTemperatureDependentContactAngleForce::perturbedTemperatureDependentContactAngleForce(), PhaseChangeModel< CloudType >::PhaseChangeModel(), phaseChangeModel::phaseChangeModel(), PilchErdman< CloudType >::PilchErdman(), primaryRadiation::primaryRadiation(), RanzMarshall< CloudType >::RanzMarshall(), ReactingLookupTableInjection< CloudType >::ReactingLookupTableInjection(), ReactingMultiphaseLookupTableInjection< CloudType >::ReactingMultiphaseLookupTableInjection(), ReactingWeberNumber< CloudType >::ReactingWeberNumber(), Rebound< CloudType >::Rebound(), RecycleInteraction< CloudType >::RecycleInteraction(), ReitzDiwakar< CloudType >::ReitzDiwakar(), ReitzKHRT< CloudType >::ReitzKHRT(), Relaxation< CloudType >::Relaxation(), RemoveParcels< CloudType >::RemoveParcels(), SHF< CloudType >::SHF(), SingleKineticRateDevolatilisation< CloudType >::SingleKineticRateDevolatilisation(), SingleMixtureFraction< CloudType >::SingleMixtureFraction(), SinglePhaseMixture< CloudType >::SinglePhaseMixture(), solidification::solidification(), standardPhaseChange::standardPhaseChange(), standardRadiation::standardRadiation(), StandardWallInteraction< CloudType >::StandardWallInteraction(), Stochastic< CloudType >::Stochastic(), StochasticCollisionModel< CloudType >::StochasticCollisionModel(), subModelBase(), subModelBase(), SuppressionCollision< CloudType >::SuppressionCollision(), SurfaceFilmModel< CloudType >::SurfaceFilmModel(), SurfaceReactionModel< CloudType >::SurfaceReactionModel(), TAB< CloudType >::TAB(), temperatureDependentContactAngleForce::temperatureDependentContactAngleForce(), thermocapillaryForce::thermocapillaryForce(), ThermoLookupTableInjection< CloudType >::ThermoLookupTableInjection(), ThermoReynoldsNumber< CloudType >::ThermoReynoldsNumber(), thixotropicViscosity::thixotropicViscosity(), transferModel::transferModel(), transferModelList::transferModelList(), BlobsSheetAtomization< CloudType >::TypeName(), CellZoneInjection< CloudType >::TypeName(), ConeInjection< CloudType >::TypeName(), ConeNozzleInjection< CloudType >::TypeName(), ConstantRateDevolatilisation< CloudType >::TypeName(), COxidationDiffusionLimitedRate< CloudType >::TypeName(), COxidationHurtMitchell< CloudType >::TypeName(), COxidationIntrinsicRate< CloudType >::TypeName(), COxidationKineticDiffusionLimitedRate< CloudType >::TypeName(), COxidationMurphyShaddix< CloudType >::TypeName(), NoDamping< CloudType >::TypeName(), Relaxation< CloudType >::TypeName(), DispersionRASModel< CloudType >::TypeName(), FaceInteraction< CloudType >::TypeName(), FacePostProcessing< CloudType >::TypeName(), FieldActivatedInjection< CloudType >::TypeName(), FreezeParticles< CloudType >::TypeName(), InflationInjection< CloudType >::TypeName(), InjectedParticleDistributionInjection< CloudType >::TypeName(), InjectedParticleInjection< CloudType >::TypeName(), NoIsotropy< CloudType >::TypeName(), Stochastic< CloudType >::TypeName(), KinematicLookupTableInjection< CloudType >::TypeName(), KinematicSurfaceFilm< CloudType >::TypeName(), LiquidEvapFuchsKnudsen< CloudType >::TypeName(), LiquidEvaporation< CloudType >::TypeName(), LiquidEvaporationBoil< CloudType >::TypeName(), LocalInteraction< CloudType >::TypeName(), ManualInjection< CloudType >::TypeName(), MUCSheterogeneousRate< CloudType >::TypeName(), MultiInteraction< CloudType >::TypeName(), NoAtomization< CloudType >::TypeName(), NoCollision< CloudType >::TypeName(), NoComposition< CloudType >::TypeName(), NoDispersion< CloudType >::TypeName(), NoheterogeneousReacting< CloudType >::TypeName(), NoInteraction< CloudType >::TypeName(), NoStochasticCollision< CloudType >::TypeName(), NoSurfaceReaction< CloudType >::TypeName(), ORourkeCollision< CloudType >::TypeName(), Explicit< CloudType >::TypeName(), Implicit< CloudType >::TypeName(), NoPacking< CloudType >::TypeName(), PairCollision< CloudType >::TypeName(), ParticleCollector< CloudType >::TypeName(), ParticleErosion< CloudType >::TypeName(), ParticleHistogram< CloudType >::TypeName(), ParticlePostProcessing< CloudType >::TypeName(), ParticleTracks< CloudType >::TypeName(), ParticleTrap< CloudType >::TypeName(), ParticleZoneInfo< CloudType >::TypeName(), PatchCollisionDensity< CloudType >::TypeName(), PatchFlowRateInjection< CloudType >::TypeName(), PatchInjection< CloudType >::TypeName(), PatchInteractionFields< CloudType >::TypeName(), ReactingLookupTableInjection< CloudType >::TypeName(), ReactingMultiphaseLookupTableInjection< CloudType >::TypeName(), ReactingWeberNumber< CloudType >::TypeName(), Rebound< CloudType >::TypeName(), RecycleInteraction< CloudType >::TypeName(), BrunDrippingInjection::TypeName(), contactAngleForce::TypeName(), dynamicContactAngleForce::TypeName(), filmSeparation::TypeName(), ArrheniusViscosity::TypeName(), constantFilmThermo::TypeName(), constantHeatTransfer::TypeName(), constantRadiation::TypeName(), constantViscosity::TypeName(), curvatureSeparation::TypeName(), distributionContactAngleForce::TypeName(), drippingInjection::TypeName(), function1Viscosity::TypeName(), laminar::TypeName(), liquidFilmThermo::TypeName(), liquidViscosity::TypeName(), mappedConvectiveHeatTransfer::TypeName(), noPhaseChange::TypeName(), noRadiation::TypeName(), patchInjection::TypeName(), perturbedTemperatureDependentContactAngleForce::TypeName(), primaryRadiation::TypeName(), solidification::TypeName(), standardPhaseChange::TypeName(), standardRadiation::TypeName(), temperatureDependentContactAngleForce::TypeName(), thermocapillaryForce::TypeName(), thixotropicViscosity::TypeName(), waxSolventEvaporation::TypeName(), waxSolventViscosity::TypeName(), RemoveParcels< CloudType >::TypeName(), SingleKineticRateDevolatilisation< CloudType >::TypeName(), SingleMixtureFraction< CloudType >::TypeName(), SinglePhaseMixture< CloudType >::TypeName(), StandardWallInteraction< CloudType >::TypeName(), SuppressionCollision< CloudType >::TypeName(), TAB< CloudType >::TypeName(), ThermoLookupTableInjection< CloudType >::TypeName(), VoidFraction< CloudType >::TypeName(), VoFPatchTransfer::VoFPatchTransfer(), VoidFraction< CloudType >::VoidFraction(), waxSolventEvaporation::waxSolventEvaporation(), waxSolventViscosity::waxSolventViscosity(), CloudFunctionObject< CloudType >::~CloudFunctionObject(), HeatTransferModel< CloudType >::~HeatTransferModel(), HeterogeneousReactingModel< CloudType >::~HeterogeneousReactingModel(), InjectionModel< CloudType >::~InjectionModel(), PatchInteractionModel< CloudType >::~PatchInteractionModel(), PhaseChangeModel< CloudType >::~PhaseChangeModel(), ~subModelBase(), SurfaceFilmModel< CloudType >::~SurfaceFilmModel(), and SurfaceReactionModel< CloudType >::~SurfaceReactionModel().

◆ baseName()

◆ modelType()

const Foam::word & modelType ( ) const

Return const access to the sub-model type.

Definition at line 116 of file subModelBase.C.

References modelType_.

Referenced by CloudSubModelBase< CloudType >::CloudSubModelBase(), CloudSubModelBase< Foam::CollidingCloud< Foam::DSMCCloud< dsmcParcel > > >::CloudSubModelBase(), InjectionModel< CloudType >::declareRunTimeSelectionTable(), force::declareRunTimeSelectionTable(), injectionModel::declareRunTimeSelectionTable(), filmRadiationModel::declareRunTimeSelectionTable(), filmThermoModel::declareRunTimeSelectionTable(), filmTurbulenceModel::declareRunTimeSelectionTable(), filmViscosityModel::declareRunTimeSelectionTable(), force::declareRunTimeSelectionTable(), heatTransferModel::declareRunTimeSelectionTable(), injectionModel::declareRunTimeSelectionTable(), phaseChangeModel::declareRunTimeSelectionTable(), transferModel::declareRunTimeSelectionTable(), filmRadiationModel::filmRadiationModel(), filmSubModelBase::filmSubModelBase(), filmSubModelBase::filmSubModelBase(), filmSubModelBase::filmSubModelBase(), filmSubModelBase::filmSubModelBase(), filmThermoModel::filmThermoModel(), filmTurbulenceModel::filmTurbulenceModel(), filmSubModelBase::filmType(), filmViscosityModel::filmViscosityModel(), force::force(), force::force(), heatTransferModel::heatTransferModel(), InjectionModel< CloudType >::InjectionModel(), injectionModel::injectionModel(), injectionModel::injectionModel(), AtomizationModel< CloudType >::New(), BreakupModel< CloudType >::New(), CollisionModel< CloudType >::New(), CompositionModel< CloudType >::New(), DampingModel< CloudType >::New(), DevolatilisationModel< CloudType >::New(), DispersionModel< CloudType >::New(), HeatTransferModel< CloudType >::New(), HeterogeneousReactingModel< CloudType >::New(), InjectionModel< CloudType >::New(), InjectionModel< CloudType >::New(), IsotropyModel< CloudType >::New(), PackingModel< CloudType >::New(), PatchInteractionModel< CloudType >::New(), PhaseChangeModel< CloudType >::New(), force::New(), injectionModel::New(), filmRadiationModel::New(), filmThermoModel::New(), filmTurbulenceModel::New(), filmViscosityModel::New(), force::New(), heatTransferModel::New(), injectionModel::New(), phaseChangeModel::New(), transferModel::New(), StochasticCollisionModel< CloudType >::New(), SurfaceFilmModel< CloudType >::New(), SurfaceReactionModel< CloudType >::New(), phaseChangeModel::phaseChangeModel(), subModelBase(), subModelBase(), transferModel::transferModel(), PatchInteractionModel< CloudType >::writeFileHeader(), and InjectionModel< CloudType >::~InjectionModel().

◆ coeffDict()

const Foam::dictionary & coeffDict ( ) const

Return const access to the coefficients dictionary.

Definition at line 122 of file subModelBase.C.

References coeffDict_.

Referenced by LiquidEvapFuchsKnudsen< CloudType >::activityCoeff(), BlobsSheetAtomization< CloudType >::BlobsSheetAtomization(), BreakupModel< CloudType >::BreakupModel(), CellZoneInjection< CloudType >::CellZoneInjection(), CompositionModel< CloudType >::CompositionModel(), ConeInjection< CloudType >::ConeInjection(), ConeNozzleInjection< CloudType >::ConeNozzleInjection(), ConstantRateDevolatilisation< CloudType >::ConstantRateDevolatilisation(), COxidationDiffusionLimitedRate< CloudType >::COxidationDiffusionLimitedRate(), COxidationHurtMitchell< CloudType >::COxidationHurtMitchell(), COxidationIntrinsicRate< CloudType >::COxidationIntrinsicRate(), COxidationKineticDiffusionLimitedRate< CloudType >::COxidationKineticDiffusionLimitedRate(), COxidationMurphyShaddix< CloudType >::COxidationMurphyShaddix(), DampingModel< CloudType >::DampingModel(), ETAB< CloudType >::ETAB(), Explicit< CloudType >::Explicit(), FaceInteraction< CloudType >::FaceInteraction(), FacePostProcessing< CloudType >::FacePostProcessing(), FieldActivatedInjection< CloudType >::FieldActivatedInjection(), HeatTransferModel< CloudType >::HeatTransferModel(), HeterogeneousReactingModel< CloudType >::HeterogeneousReactingModel(), Implicit< CloudType >::Implicit(), InflationInjection< CloudType >::InflationInjection(), KinematicSurfaceFilm< CloudType >::init(), InjectedParticleDistributionInjection< CloudType >::InjectedParticleDistributionInjection(), InjectedParticleInjection< CloudType >::InjectedParticleInjection(), InjectionModel< CloudType >::InjectionModel(), IsotropyModel< CloudType >::IsotropyModel(), KinematicLookupTableInjection< CloudType >::KinematicLookupTableInjection(), KinematicSurfaceFilm< CloudType >::KinematicSurfaceFilm(), LiquidEvapFuchsKnudsen< CloudType >::LiquidEvapFuchsKnudsen(), LiquidEvaporation< CloudType >::LiquidEvaporation(), LiquidEvaporationBoil< CloudType >::LiquidEvaporationBoil(), LISAAtomization< CloudType >::LISAAtomization(), LocalInteraction< CloudType >::LocalInteraction(), ManualInjection< CloudType >::ManualInjection(), MUCSheterogeneousRate< CloudType >::MUCSheterogeneousRate(), MultiInteraction< CloudType >::MultiInteraction(), ORourkeCollision< CloudType >::ORourkeCollision(), PackingModel< CloudType >::PackingModel(), PairCollision< CloudType >::PairCollision(), ParticleCollector< CloudType >::ParticleCollector(), ParticleDose< CloudType >::ParticleDose(), ParticleErosion< CloudType >::ParticleErosion(), ParticleHistogram< CloudType >::ParticleHistogram(), ParticlePostProcessing< CloudType >::ParticlePostProcessing(), ParticleTracks< CloudType >::ParticleTracks(), ParticleTrap< CloudType >::ParticleTrap(), ParticleZoneInfo< CloudType >::ParticleZoneInfo(), PatchFlowRateInjection< CloudType >::PatchFlowRateInjection(), PatchInjection< CloudType >::PatchInjection(), PatchInteractionFields< CloudType >::PatchInteractionFields(), PatchInteractionModel< Foam::KinematicCloud< Foam::DSMCCloud< dsmcParcel > > >::PatchInteractionModel(), PhaseChangeModel< CloudType >::PhaseChangeModel(), PilchErdman< CloudType >::PilchErdman(), RanzMarshall< CloudType >::RanzMarshall(), ReactingLookupTableInjection< CloudType >::ReactingLookupTableInjection(), ReactingMultiphaseLookupTableInjection< CloudType >::ReactingMultiphaseLookupTableInjection(), Rebound< CloudType >::Rebound(), RecycleInteraction< CloudType >::RecycleInteraction(), ReitzDiwakar< CloudType >::ReitzDiwakar(), ReitzKHRT< CloudType >::ReitzKHRT(), RemoveParcels< CloudType >::RemoveParcels(), SHF< CloudType >::SHF(), SingleKineticRateDevolatilisation< CloudType >::SingleKineticRateDevolatilisation(), SingleMixtureFraction< CloudType >::SingleMixtureFraction(), StandardWallInteraction< CloudType >::StandardWallInteraction(), SuppressionCollision< CloudType >::SuppressionCollision(), SurfaceFilmModel< CloudType >::SurfaceFilmModel(), TAB< CloudType >::TAB(), ThermoLookupTableInjection< CloudType >::ThermoLookupTableInjection(), TrajectoryCollision< CloudType >::TrajectoryCollision(), FacePostProcessing< CloudType >::write(), and ParticleCollector< CloudType >::write().

◆ properties()

const Foam::dictionary & properties ( ) const

Return const access to the properties dictionary.

Definition at line 128 of file subModelBase.C.

References properties_.

Referenced by CompositionModel< Foam::ReactingCloud< Foam::DSMCCloud< dsmcParcel > > >::Hc(), CompositionModel< Foam::ReactingCloud< Foam::DSMCCloud< dsmcParcel > > >::rho(), subModelBase(), subModelBase(), and subModelBase().

Here is the caller graph for this function:

◆ defaultCoeffs()

bool defaultCoeffs ( const bool printMsg) const
virtual

Returns true if defaultCoeffs is true and outputs on printMsg.

Definition at line 134 of file subModelBase.C.

References coeffDict_, Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), and Foam::Info.

Referenced by ETAB< CloudType >::ETAB(), PilchErdman< CloudType >::PilchErdman(), ReitzDiwakar< CloudType >::ReitzDiwakar(), and ReitzKHRT< CloudType >::ReitzKHRT().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ active()

◆ cacheFields()

void cacheFields ( const bool store)
virtual

Cache dependent sub-model fields.

Reimplemented in Relaxation< CloudType >, DispersionRASModel< CloudType >, GradientDispersionRAS< CloudType >, Explicit< CloudType >, and Implicit< CloudType >.

Definition at line 155 of file subModelBase.C.

Referenced by Explicit< CloudType >::cacheFields(), and Implicit< CloudType >::cacheFields().

Here is the caller graph for this function:

◆ writeTime()

◆ localPath()

◆ getBaseProperty() [1/2]

template<class Type>
Type getBaseProperty ( const word & entryName,
const Type & defaultValue = Type(Zero) ) const

◆ getBaseProperty() [2/2]

template<class Type>
void getBaseProperty ( const word & entryName,
Type & value ) const

Retrieve generic property from the base model.

Definition at line 43 of file subModelBaseTemplates.C.

References baseName_, properties_, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ setBaseProperty()

template<class Type>
void setBaseProperty ( const word & entryName,
const Type & value )

Add generic property to the base model.

Definition at line 58 of file subModelBaseTemplates.C.

References dictionary::add(), baseName_, dictionary, and properties_.

Referenced by DevolatilisationModel< CloudType >::info(), HeterogeneousReactingModel< CloudType >::info(), PhaseChangeModel< CloudType >::info(), injectionModelList::info(), transferModelList::info(), and SurfaceReactionModel< CloudType >::info().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getModelDict()

bool getModelDict ( const word & entryName,
dictionary & dict ) const

Retrieve dictionary, return true if set.

Definition at line 176 of file subModelBase.C.

References baseName_, dict(), dictionary::found(), inLine(), modelName_, modelType_, properties_, dictionary::subDict(), and dictionary::subOrEmptyDict().

Here is the call graph for this function:

◆ getModelProperty() [1/2]

template<class Type>
bool getModelProperty ( const word & entryName,
Type & value ) const

◆ getModelProperty() [2/2]

template<class Type>
Type getModelProperty ( const word & entryName,
const Type & defaultValue = Type(Zero) ) const

Retrieve generic property from the sub-model.

Definition at line 103 of file subModelBaseTemplates.C.

References getModelProperty().

Here is the call graph for this function:

◆ setModelProperty()

◆ write()

Member Data Documentation

◆ modelName_

◆ properties_

dictionary& properties_
protected

Reference to properties dictionary e.g. for restart.

Definition at line 72 of file subModelBase.H.

Referenced by getBaseProperty(), getBaseProperty(), getModelDict(), getModelProperty(), properties(), setBaseProperty(), setModelProperty(), subModelBase(), subModelBase(), subModelBase(), and subModelBase().

◆ dict_

const dictionary dict_
protected

Copy of dictionary used during construction.

Definition at line 77 of file subModelBase.H.

Referenced by dict(), subModelBase(), subModelBase(), subModelBase(), and subModelBase().

◆ baseName_

const word baseName_
protected

◆ modelType_

const word modelType_
protected

◆ coeffDict_

const dictionary coeffDict_
protected

Coefficients dictionary.

Definition at line 92 of file subModelBase.H.

Referenced by ArrheniusViscosity::ArrheniusViscosity(), BrunDrippingInjection::BrunDrippingInjection(), BrunDrippingInjection::BrunDrippingInjection(), coeffDict(), constantFilmThermo::constantFilmThermo(), constantHeatTransfer::constantHeatTransfer(), constantRadiation::constantRadiation(), constantViscosity::constantViscosity(), contactAngleForce::contactAngleForce(), contactAngleForce::contactAngleForce(), constantFilmThermo::Cp(), curvatureSeparation::curvatureSeparation(), constantFilmThermo::D(), defaultCoeffs(), distributionContactAngleForce::distributionContactAngleForce(), drippingInjection::drippingInjection(), dynamicContactAngleForce::dynamicContactAngleForce(), filmSeparation::filmSeparation(), function1Viscosity::function1Viscosity(), constantFilmThermo::hl(), constantFilmThermo::kappa(), laminar::laminar(), liquidFilmThermo::liquidFilmThermo(), constantFilmThermo::mu(), patchInjection::patchInjection(), perturbedTemperatureDependentContactAngleForce::perturbedTemperatureDependentContactAngleForce(), constantFilmThermo::pv(), constantFilmThermo::rho(), constantFilmThermo::sigma(), solidification::solidification(), standardPhaseChange::standardPhaseChange(), standardRadiation::standardRadiation(), subModelBase(), subModelBase(), subModelBase(), subModelBase(), constantFilmThermo::Tb(), temperatureDependentContactAngleForce::temperatureDependentContactAngleForce(), thixotropicViscosity::thixotropicViscosity(), constantFilmThermo::W(), waxSolventEvaporation::waxSolventEvaporation(), waxSolventViscosity::waxSolventViscosity(), and write().

◆ log


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