thermal Class Reference

Base class for clouds with thermodynamic modelling. More...

Inheritance diagram for thermal:
Collaboration diagram for thermal:

Public Member Functions

 TypeName ("thermal")
 Run-time type information. More...
 
 thermal (const cloud &, const shaped &, const carried &)
 Construct from a reference to the cloud and its base classes. More...
 
virtual ~thermal ()
 Destructor. More...
 
template<class Thermo , class ... Thermos>
bool isThermo () const
 Determine whether the thermo model is one of the given types. More...
 
template<class Thermo , class ... Thermos>
void assertThermo () const
 Generate an error if the thermo model is not one of the given types. More...
 
template<class Thermo , class ... Thermos>
void assertThermo (const LagrangianModel &model) const
 Generate an error if the thermo model is not one of the given. More...
 
template<class Thermo = basicLagrangianThermo, class ... Args>
const Thermo & thermo (const Args &... args) const
 Get a reference to the thermodynamic model of a given type. More...
 
template<class Thermo = basicLagrangianThermo, class ... Args>
Thermo & thermo (const Args &... args)
 Non-const override of the above. More...
 
- Public Member Functions inherited from massive
 TypeName ("massive")
 Run-time type information. More...
 
virtual ~massive ()
 Destructor. More...
 

Public Attributes

const LagrangianScalarDynamicFieldT
 Temperature. More...
 
CloudStateFieldRef< scalar > e
 Internal energy. More...
 
const LagrangianScalarDynamicFieldCv
 Heat capacity at constant volume. More...
 
const LagrangianScalarDynamicFieldkappa
 Thermal conductivity. More...
 
- Public Attributes inherited from massive
CloudStateFieldRef< scalar > rho
 Density. More...
 
const CloudDerivedField< scalar > & m
 Mass. More...
 

Friends

template<class Thermo >
class Thermal
 Declare friendship with templated derivation. More...
 

Additional Inherited Members

- Static Public Attributes inherited from massive
static const word mName
 Name of mass fields. More...
 
- Protected Member Functions inherited from massive
 massive (const cloud &, const shaped &, LagrangianScalarDynamicField &)
 Construct from a reference to the cloud and its base classes and. More...
 

Detailed Description

Base class for clouds with thermodynamic modelling.

Source files

Definition at line 52 of file thermal.H.

Constructor & Destructor Documentation

◆ thermal()

thermal ( const cloud c,
const shaped shapedCloud,
const carried carriedCloud 
)

Construct from a reference to the cloud and its base classes.

Definition at line 60 of file thermal.C.

◆ ~thermal()

~thermal ( )
virtual

Destructor.

Definition at line 73 of file thermal.C.

Member Function Documentation

◆ TypeName()

TypeName ( "thermal"  )

Run-time type information.

◆ isThermo()

bool isThermo

Determine whether the thermo model is one of the given types.

Definition at line 46 of file thermalTemplates.C.

References Foam::isA().

Here is the call graph for this function:

◆ assertThermo() [1/2]

void assertThermo

Generate an error if the thermo model is not one of the given types.

Definition at line 53 of file thermalTemplates.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and autoPtr< T >::operator()().

Here is the call graph for this function:

◆ assertThermo() [2/2]

void assertThermo ( const LagrangianModel model) const

Generate an error if the thermo model is not one of the given.

types. A model is provided to give the error message some context.

Definition at line 69 of file thermalTemplates.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, LagrangianModel::name(), and autoPtr< T >::operator()().

Here is the call graph for this function:

◆ thermo() [1/2]

const Thermo & thermo ( const Args &...  args) const

Get a reference to the thermodynamic model of a given type.

Definition at line 85 of file thermalTemplates.C.

References args.

Referenced by multicomponentParcel::multicomponentParcel(), multicomponentParticle::multicomponentParticle(), multicomponentThermal::multicomponentThermal(), parcel::parcel(), and particle::particle().

Here is the caller graph for this function:

◆ thermo() [2/2]

Thermo & thermo ( const Args &...  args)

Non-const override of the above.

Definition at line 93 of file thermalTemplates.C.

References args.

Friends And Related Function Documentation

◆ Thermal

friend class Thermal
friend

Declare friendship with templated derivation.

Definition at line 76 of file thermal.H.

Member Data Documentation

◆ T

Temperature.

Definition at line 94 of file thermal.H.

◆ e

CloudStateFieldRef<scalar> e

Internal energy.

Definition at line 97 of file thermal.H.

◆ Cv

Heat capacity at constant volume.

Definition at line 100 of file thermal.H.

◆ kappa

Thermal conductivity.

Definition at line 103 of file thermal.H.


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