Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
LagrangianModel Class Referenceabstract

Base class for Lagrangian models. More...

Inheritance diagram for LagrangianModel:
Inheritance graph
[legend]
Collaboration diagram for LagrangianModel:
Collaboration graph
[legend]

Classes

class  iNew
 List construction class. More...
 

Public Types

enum class  modification : label { change = 0 , remove = 1 }
 Enumeration of the types of instantaneous modification. More...
 
typedef LagrangianMesh::elementGroup< modification > elementModification
 Class containing an element-index and a modification-enumeration. More...
 

Public Member Functions

 TypeName ("LagrangianModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, LagrangianModel, dictionary,(const word &name, const LagrangianMesh &mesh, const dictionary &modelDict, const dictionary &stateDict),(name, mesh, modelDict, stateDict))
 Declare run-time constructor selection table. More...
 
 LagrangianModel (const word &name, const LagrangianMesh &mesh)
 Construct from components. More...
 
 LagrangianModel (const LagrangianModel &)=delete
 Disallow default bitwise copy construction. More...
 
autoPtr< LagrangianModel > clone () const
 Clone. More...
 
virtual ~LagrangianModel ()
 Destructor. More...
 
const word & name () const
 The source name. More...
 
const objectRegistry & db () const
 The database. More...
 
const Time & time () const
 Return time. More...
 
const LagrangianMesh & mesh () const
 The mesh. More...
 
virtual wordList addSupFields () const
 Return the list of fields for which the LagrangianModel adds. More...
 
virtual bool addsSupToField (const word &fieldName, const word &eqnFieldName) const =0
 Return true if the LagrangianModel adds a source term to the. More...
 
template<class Type , template< class > class PrimitiveField, template< class > class PrimitiveEqnField>
bool addsSupToField (const LagrangianSubField< Type, PrimitiveField > &field, const LagrangianSubField< Type, PrimitiveEqnField > &eqnfield) const
 Return true if the LagrangianModels adds a source term to the. More...
 
virtual void postConstruct ()
 Do post construction steps which require access to other models. More...
 
virtual void correct ()
 Correct the LagrangianModel. More...
 
virtual void preModify (const LagrangianMesh &mesh, DynamicList< elementModification > &elementModifications) const
 Identify elements in the Lagrangian mesh which are to be. More...
 
virtual LagrangianSubMesh modify (LagrangianMesh &mesh, const LagrangianSubMesh &modifiedMesh) const
 Instantaneously modify and/or create and remove elements in the. More...
 
virtual void calculate (const LagrangianSubScalarField &deltaT, const bool final)
 Solve equations and/or update continually changing properties. More...
 
virtual void preAddSup (const LagrangianSubScalarField &deltaT, const bool final)
 Hook before source evaluation. More...
 
virtual void addSup (const LagrangianSubScalarField &deltaT, LagrangianEqn< scalar > &eqn) const
 Add a fractional source term. More...
 
virtual void postAddSup (const LagrangianSubScalarField &deltaT, const bool final)
 Add a source term to an equation. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
virtual bool read (const dictionary &modelDict)
 Read dictionary. More...
 
virtual bool write (const bool write) const
 Write data. More...
 
void operator= (const LagrangianModel &)=delete
 Disallow default bitwise assignment. More...
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::word fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 
template<class Type , class GeoMesh , template< class > class PrimitiveField>
const Foam::word & fieldName (const GeometricField< Type, GeoMesh, PrimitiveField > &field)
 
template<class Type , class GeoMesh , template< class > class PrimitiveField>
const Foam::word & fieldName (const DimensionedField< Type, GeoMesh, PrimitiveField > &field)
 
template<class Type , template< class > class PrimitiveField>
Foam::word fieldName (const DimensionedField< Type, LagrangianSubMesh, PrimitiveField > &field)
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::word fieldsName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 
template<class AlphaRhoFieldType >
Foam::word fieldsName (const AlphaRhoFieldType &alphaRhoField)
 
- Public Member Functions inherited from stateModel
 stateModel ()
 Construct null. More...
 
 stateModel (const stateModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~stateModel ()
 Destructor. More...
 
bool writeState (const bool write) const
 Write state. More...
 
virtual void writeState (Ostream &os) const
 Write state. More...
 
virtual void writeProcessorState (Ostream &os) const
 Write processor state. More...
 
void operator= (const stateModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static word fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 Return the name of the field associated with a source term. More...
 
template<class Type , class GeoMesh , template< class > class PrimitiveField>
static const word & fieldName (const GeometricField< Type, GeoMesh, PrimitiveField > &)
 Return the name of the field associated with a source term (base. More...
 
template<class Type , class GeoMesh , template< class > class PrimitiveField>
static const word & fieldName (const DimensionedField< Type, GeoMesh, PrimitiveField > &)
 Return the name of the field associated with a source term (base. More...
 
template<class Type , template< class > class PrimitiveField>
static word fieldName (const DimensionedField< Type, LagrangianSubMesh, PrimitiveField > &)
 Return the name of the field associated with a source term (base. More...
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static word fieldsName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 Return the name of the product of the fields associated with a. More...
 
template<class AlphaRhoFieldType >
static word fieldsName (const AlphaRhoFieldType &alphaRhoField)
 Return the name of the product of the fields associated with a. More...
 
static autoPtr< LagrangianModel > New (const word &name, const LagrangianMesh &mesh, const dictionary &modelDict)
 Selector. More...
 
- Static Public Member Functions inherited from stateModel
static dictionary stateDict (const word &name, const objectRegistry &db)
 Construct and return the state dictionary for reading. More...
 

Protected Member Functions

template<class Type >
void addSupType (const LagrangianSubScalarField &deltaT, const LagrangianSubSubField< Type > &field, LagrangianEqn< Type > &eqn) const
 Add a source term to an equation. More...
 
template<class Type >
void addSupType (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const LagrangianSubSubField< Type > &field, LagrangianEqn< Type > &eqn) const
 Add a source term to a volume or mass-weighted equation. More...
 

Detailed Description

Base class for Lagrangian models.

Source files

Definition at line 56 of file LagrangianModel.H.

Member Typedef Documentation

◆ elementModification

typedef LagrangianMesh::elementGroup<modification> elementModification

Class containing an element-index and a modification-enumeration.

Definition at line 75 of file LagrangianModel.H.

Member Enumeration Documentation

◆ modification

enum modification : label
strong

Enumeration of the types of instantaneous modification.

Enumerator
change 
remove 

Definition at line 65 of file LagrangianModel.H.

Constructor & Destructor Documentation

◆ LagrangianModel() [1/2]

LagrangianModel ( const word &  name,
const LagrangianMesh &  mesh 
)

Construct from components.

Definition at line 62 of file LagrangianModel.C.

◆ LagrangianModel() [2/2]

LagrangianModel ( const LagrangianModel &  )
delete

Disallow default bitwise copy construction.

◆ ~LagrangianModel()

~LagrangianModel ( )
virtual

Destructor.

Definition at line 132 of file LagrangianModel.C.

Member Function Documentation

◆ addSupType() [1/2]

void addSupType ( const LagrangianSubScalarField &  deltaT,
const LagrangianSubSubField< Type > &  field,
LagrangianEqn< Type > &  eqn 
) const
protected

Add a source term to an equation.

Definition at line 40 of file LagrangianModel.C.

◆ addSupType() [2/2]

void addSupType ( const LagrangianSubScalarField &  deltaT,
const LagrangianSubScalarSubField &  vOrM,
const LagrangianSubSubField< Type > &  field,
LagrangianEqn< Type > &  eqn 
) const
protected

Add a source term to a volume or mass-weighted equation.

Definition at line 50 of file LagrangianModel.C.

◆ TypeName()

TypeName ( "LagrangianModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
LagrangianModel  ,
dictionary  ,
(const word &name, const LagrangianMesh &mesh, const dictionary &modelDict, const dictionary &stateDict)  ,
(name, mesh, modelDict, stateDict)   
)

Declare run-time constructor selection table.

◆ fieldName() [1/8]

static word fieldName ( const AlphaRhoFieldType &  alphaRhoField,
const AlphaRhoFieldTypes &...  alphaRhoFields 
)
static

Return the name of the field associated with a source term.

Referenced by LagrangianModels::addsSupToField(), LagrangianModel::fieldName(), and LagrangianModels::sourceTerm().

Here is the caller graph for this function:

◆ fieldName() [2/8]

static const word& fieldName ( const GeometricField< Type, GeoMesh, PrimitiveField > &  )
static

Return the name of the field associated with a source term (base.

condition for the above)

◆ fieldName() [3/8]

static const word& fieldName ( const DimensionedField< Type, GeoMesh, PrimitiveField > &  )
static

Return the name of the field associated with a source term (base.

condition for the above)

◆ fieldName() [4/8]

static word fieldName ( const DimensionedField< Type, LagrangianSubMesh, PrimitiveField > &  )
static

Return the name of the field associated with a source term (base.

condition for the above)

◆ fieldsName() [1/4]

static word fieldsName ( const AlphaRhoFieldType &  alphaRhoField,
const AlphaRhoFieldTypes &...  alphaRhoFields 
)
static

Return the name of the product of the fields associated with a.

source term

Referenced by LagrangianModels::sourceTerm().

Here is the caller graph for this function:

◆ fieldsName() [2/4]

static word fieldsName ( const AlphaRhoFieldType &  alphaRhoField)
static

Return the name of the product of the fields associated with a.

source term (base condition for the above)

◆ clone()

autoPtr<LagrangianModel> clone ( ) const
inline

Clone.

Definition at line 211 of file LagrangianModel.H.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::LagrangianModel > New ( const word &  name,
const LagrangianMesh &  mesh,
const dictionary &  modelDict 
)
static

Selector.

Definition at line 75 of file LagrangianModel.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, FatalIOErrorInFunction, Foam::indentOrNl(), Foam::Info, Foam::libs, dictionary::lookup(), mesh, Foam::name(), Foam::nl, dlLibraryTable::open(), dictionary::optionalTypeDict(), and Foam::type().

Referenced by LagrangianModels::LagrangianModels(), and LagrangianModel::iNew::operator()().

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

◆ name()

const Foam::word & name ( ) const
inlinevirtual

The source name.

Implements stateModel.

Definition at line 30 of file LagrangianModelI.H.

Referenced by cloudLagrangianFieldSource::assertCloud(), thermal::assertThermo(), LagrangianFieldSourceBase::fieldSource(), LagrangianFieldSourceBase::fieldSourceCast(), turbulentDispersion::initialiseTurbField(), LagrangianModels::modelTypeFieldSourceType< ModelType, FieldSourceType, ModelAndFieldSourceTypes ... >::insert(), internalLagrangianFieldSource< Type >::internalCoeff(), maxLagrangianFieldSource< Type >::internalCoeff(), NaNLagrangianFieldSource< Type >::internalCoeff(), uniformFixedValueLagrangianFieldSource< Type >::internalCoeff(), zeroLagrangianFieldSource< Type >::internalCoeff(), LagrangianFieldSource< Type >::internalCoeff(), LagrangianFieldSourceBase::modelCast(), CloudStateFieldRef< Type >::operator()(), internalLagrangianFieldSource< Type >::sourceValue(), maxLagrangianFieldSource< Type >::sourceValue(), NaNLagrangianFieldSource< Type >::sourceValue(), zeroLagrangianFieldSource< Type >::sourceValue(), LagrangianFieldSource< Type >::sourceValue(), distributionDiameterLagrangianScalarFieldSource::value(), flowRateConeDiskVelocityLagrangianVectorFieldSource::value(), maxLagrangianFieldSource< Type >::value(), NaNLagrangianFieldSource< Type >::value(), noneStateLagrangianLabelFieldSource::value(), zeroLagrangianFieldSource< Type >::value(), LagrangianFieldSource< Type >::value(), compressibilityLagrangianScalarFieldSource::value(), densityLagrangianScalarFieldSource::value(), dynamicViscosityLagrangianScalarFieldSource::value(), energyLagrangianScalarFieldSource::value(), specificHeatCapacityLagrangianScalarFieldSource::value(), thermalConductivityLagrangianScalarFieldSource::value(), and multicomponentLagrangianThermo::implementation::Yslicer().

Here is the caller graph for this function:

◆ db()

const Foam::objectRegistry & db ( ) const
inlinevirtual

The database.

Implements stateModel.

Definition at line 36 of file LagrangianModelI.H.

◆ time()

const Foam::Time & time ( ) const
inline

Return time.

Definition at line 42 of file LagrangianModelI.H.

References objectRegistry::time().

Referenced by turbulentDispersion::initialiseTurbField().

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

◆ mesh()

const Foam::LagrangianMesh & mesh ( ) const
inline

The mesh.

Definition at line 48 of file LagrangianModelI.H.

Referenced by turbulentDispersion::initialiseTurbField().

Here is the caller graph for this function:

◆ addSupFields()

Foam::wordList addSupFields ( ) const
virtual

Return the list of fields for which the LagrangianModel adds.

source term to the transport equation

Reimplemented in turbulentDispersion, SaffmanMeiLift, pressureWork, pressureGradientForce, heatTransfer, gravity, drag, constantFluxCarrierTransfer, constantCoefficientVirtualMass, and collisionPhaseTransfer.

Definition at line 138 of file LagrangianModel.C.

References List< word >::null().

Here is the call graph for this function:

◆ addsSupToField() [1/2]

virtual bool addsSupToField ( const word &  fieldName,
const word &  eqnFieldName 
) const
pure virtual

Return true if the LagrangianModel adds a source term to the.

given field's transport equation

Implemented in LagrangianInjection, turbulentDispersion, SaffmanMeiLift, pressureWork, pressureGradientForce, heatTransfer, gravity, drag, constantFluxCarrierTransfer, constantCoefficientVirtualMass, and collisionPhaseTransfer.

Referenced by LagrangianModels::addsSupToField(), LagrangianModels::source(), and LagrangianModels::sourceTerm().

Here is the caller graph for this function:

◆ addsSupToField() [2/2]

bool addsSupToField ( const LagrangianSubField< Type, PrimitiveField > &  field,
const LagrangianSubField< Type, PrimitiveEqnField > &  eqnfield 
) const

Return true if the LagrangianModels adds a source term to the.

given field's transport equation

Definition at line 114 of file LagrangianModelTemplates.C.

References IOobject::name().

Here is the call graph for this function:

◆ postConstruct()

void postConstruct ( )
virtual

Do post construction steps which require access to other models.

Reimplemented in turbulentDispersion.

Definition at line 144 of file LagrangianModel.C.

◆ correct()

void correct ( )
virtual

Correct the LagrangianModel.

Reimplemented in volumeInjection, pointInjection, and patchInjection.

Definition at line 148 of file LagrangianModel.C.

◆ preModify()

void preModify ( const LagrangianMesh &  mesh,
DynamicList< elementModification > &  elementModifications 
) const
virtual

Identify elements in the Lagrangian mesh which are to be.

instantaneously modified or removed

Definition at line 152 of file LagrangianModel.C.

◆ modify()

Foam::LagrangianSubMesh modify ( LagrangianMesh &  mesh,
const LagrangianSubMesh &  modifiedMesh 
) const
virtual

Instantaneously modify and/or create and remove elements in the.

Lagrangian mesh

Reimplemented in volumeInjection, pointInjection, patchInjection, manualInjection, and diskInjection.

Definition at line 160 of file LagrangianModel.C.

◆ calculate()

void calculate ( const LagrangianSubScalarField &  deltaT,
const bool  final 
)
virtual

Solve equations and/or update continually changing properties.

Reimplemented in constantFluxCarrierTransfer, and collisionPhaseTransfer.

Definition at line 170 of file LagrangianModel.C.

◆ preAddSup()

void preAddSup ( const LagrangianSubScalarField &  deltaT,
const bool  final 
)
virtual

Hook before source evaluation.

Reimplemented in turbulentDispersion, pressureWork, constantFluxCarrierTransfer, and collisionPhaseTransfer.

Definition at line 178 of file LagrangianModel.C.

◆ addSup()

void addSup ( const LagrangianSubScalarField &  deltaT,
LagrangianEqn< scalar > &  eqn 
) const
virtual

Add a fractional source term.

Reimplemented in collisionPhaseTransfer.

Definition at line 186 of file LagrangianModel.C.

Referenced by LagrangianModels::source(), and LagrangianModels::sourceTerm().

Here is the caller graph for this function:

◆ postAddSup()

virtual void postAddSup ( const LagrangianSubScalarField &  deltaT,
const bool  final 
)
virtual

Add a source term to an equation.

Add a source term to a volume or mass-weighted equation Hook after source evaluation

Reimplemented in turbulentDispersion, pressureWork, constantFluxCarrierTransfer, and collisionPhaseTransfer.

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  )
virtual

Update topology using the given map.

Reimplemented in volumeInjection, pointInjection, and patchInjection.

Definition at line 216 of file LagrangianModel.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap &  )
virtual

Update from another mesh using the given map.

Reimplemented in volumeInjection, pointInjection, and patchInjection.

Definition at line 220 of file LagrangianModel.C.

◆ distribute()

void distribute ( const polyDistributionMap &  )
virtual

Redistribute or update using the given distribution map.

Reimplemented in volumeInjection, pointInjection, and patchInjection.

Definition at line 224 of file LagrangianModel.C.

◆ read()

bool read ( const dictionary &  modelDict)
virtual

Read dictionary.

Reimplemented in volumeInjection, pointInjection, patchInjection, manualInjection, diskInjection, and constantFluxCarrierTransfer.

Definition at line 228 of file LagrangianModel.C.

Referenced by constantFluxCarrierTransfer::read(), diskInjection::read(), manualInjection::read(), patchInjection::read(), pointInjection::read(), and volumeInjection::read().

Here is the caller graph for this function:

◆ write()

bool write ( const bool  write) const
virtual

Write data.

Definition at line 234 of file LagrangianModel.C.

References Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const LagrangianModel &  )
delete

Disallow default bitwise assignment.

◆ fieldName() [5/8]

Foam::word fieldName ( const AlphaRhoFieldType &  alphaRhoField,
const AlphaRhoFieldTypes &...  alphaRhoFields 
)

Definition at line 31 of file LagrangianModelTemplates.C.

References LagrangianModel::fieldName().

Here is the call graph for this function:

◆ fieldName() [6/8]

const Foam::word& fieldName ( const GeometricField< Type, GeoMesh, PrimitiveField > &  field)

Definition at line 47 of file LagrangianModelTemplates.C.

References IOobject::name().

Here is the call graph for this function:

◆ fieldName() [7/8]

const Foam::word& fieldName ( const DimensionedField< Type, GeoMesh, PrimitiveField > &  field)

Definition at line 62 of file LagrangianModelTemplates.C.

References IOobject::name().

Here is the call graph for this function:

◆ fieldName() [8/8]

Foam::word fieldName ( const DimensionedField< Type, LagrangianSubMesh, PrimitiveField > &  field)

Definition at line 76 of file LagrangianModelTemplates.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), and IOobject::name().

Here is the call graph for this function:

◆ fieldsName() [3/4]

Foam::word fieldsName ( const AlphaRhoFieldType &  alphaRhoField,
const AlphaRhoFieldTypes &...  alphaRhoFields 
)

Definition at line 86 of file LagrangianModelTemplates.C.

◆ fieldsName() [4/4]

Foam::word fieldsName ( const AlphaRhoFieldType &  alphaRhoField)

Definition at line 97 of file LagrangianModelTemplates.C.

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