Loading...
Searching...
No Matches
solidProperties Class Reference

The thermophysical, mechanical properties of a solid. More...

#include <solidProperties.H>

Inheritance diagram for solidProperties:

Public Types

enum  categories { MECHANICAL = (1) , THERMAL = (2) , REGULAR = 0xFF }
 Simple categories of solid properties. More...

Public Member Functions

 TypeName ("solid")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, solidProperties,,(),())
 declareRunTimeSelectionTable (autoPtr, solidProperties, dictionary,(const dictionary &dict),(dict))
 solidProperties () noexcept
 Default construct.
 solidProperties (scalar rho, scalar Cp, scalar kappa, scalar Hf, scalar emissivity, scalar W, scalar nu, scalar E) noexcept
 Construct from components.
 solidProperties (const dictionary &dict)
 Construct from dictionary.
 solidProperties (const dictionary &dict, categories category)
 Construct from dictionary with category-specific handling.
virtual autoPtr< solidPropertiesclone () const
 Construct and return clone.
virtual ~solidProperties ()=default
 Destructor.
scalar rho () const noexcept
 Density [kg/m3].
scalar Cp () const
 Specific heat capacity [J/(kg.K)].
scalar kappa () const noexcept
 Thermal conductivity [W/(m.K)].
scalar Hf () const noexcept
 Heat of formation [J/kg].
scalar Hs (const scalar T) const
 Sensible enthalpy - reference to Tstd [J/kg].
scalar emissivity () const noexcept
 Emissivity [].
scalar W () const noexcept
 Molar weight [Kg/Kmol].
scalar nu () const noexcept
 Poisson ratio.
scalar E () const noexcept
 Young modulus [N/m2].
void readIfPresent (const dictionary &dict)
 Read and set the properties if present in the given dictionary.
virtual void writeData (Ostream &os) const
 Write the solidProperties properties.

Static Public Member Functions

template<class Derived>
static autoPtr< solidPropertiesClone (const Derived &prop)
 Clone solidProperties.
static autoPtr< solidPropertiesNew (const word &name)
 Return a pointer to a new solidProperties created from name.
static autoPtr< solidPropertiesNew (const dictionary &dict)
 Return a pointer to a new solidProperties created from dictionary.

Friends

Ostreamoperator<< (Ostream &os, const solidProperties &s)
 Ostream Operator.

Detailed Description

The thermophysical, mechanical properties of a solid.

Source files

Definition at line 50 of file solidProperties.H.

Member Enumeration Documentation

◆ categories

enum categories

Simple categories of solid properties.

Can be leveraged eg, for mechanical-only vs thermal-only etc

Enumerator
MECHANICAL 

Needs mechanical only [E, nu].

THERMAL 

Needs thermal only [Cp, kappa, emissivity?].

REGULAR 

thermal: mandatory, mechanical: optional

Definition at line 104 of file solidProperties.H.

Constructor & Destructor Documentation

◆ solidProperties() [1/4]

solidProperties ( )
noexcept

Default construct.

Definition at line 36 of file solidProperties.C.

References Foam::noexcept.

Referenced by ash::ash(), C::C(), CaCO3::CaCO3(), ash::clone(), C::clone(), CaCO3::clone(), clone(), declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), operator<<, and solidProperties().

Here is the caller graph for this function:

◆ solidProperties() [2/4]

solidProperties ( scalar rho,
scalar Cp,
scalar kappa,
scalar Hf,
scalar emissivity,
scalar W,
scalar nu,
scalar E )
noexcept

Construct from components.

Definition at line 49 of file solidProperties.C.

References Cp(), E(), emissivity(), Hf(), kappa(), Foam::noexcept, nu(), rho(), and W().

Here is the call graph for this function:

◆ solidProperties() [3/4]

solidProperties ( const dictionary & dict)
explicit

Construct from dictionary.

Definition at line 72 of file solidProperties.C.

References dict.

◆ solidProperties() [4/4]

solidProperties ( const dictionary & dict,
solidProperties::categories category )

Construct from dictionary with category-specific handling.

Definition at line 89 of file solidProperties.C.

References dict, MECHANICAL, REGULAR, solidProperties(), and THERMAL.

Here is the call graph for this function:

◆ ~solidProperties()

virtual ~solidProperties ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "solid" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr ,
solidProperties ,
() ,
()  )

References solidProperties().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr ,
solidProperties ,
dictionary ,
(const dictionary &dict) ,
(dict)  )

References Cp(), dict, E(), emissivity(), Hf(), kappa(), Foam::noexcept, nu(), rho(), solidProperties(), and W().

Here is the call graph for this function:

◆ clone()

virtual autoPtr< solidProperties > clone ( ) const
inlinevirtual

Construct and return clone.

Reimplemented in ash, C, and CaCO3.

Definition at line 178 of file solidProperties.H.

References clone(), autoPtr< T >::New(), and solidProperties().

Referenced by clone().

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

◆ Clone()

template<class Derived>
autoPtr< solidProperties > Clone ( const Derived & prop)
inlinestatic

Clone solidProperties.

Definition at line 190 of file solidProperties.H.

Referenced by ash::clone(), C::clone(), and CaCO3::clone().

Here is the caller graph for this function:

◆ New() [1/2]

Foam::autoPtr< Foam::solidProperties > New ( const word & name)
static

Return a pointer to a new solidProperties created from name.

Definition at line 27 of file solidPropertiesNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and Foam::name().

Referenced by solidMixtureProperties::solidMixtureProperties().

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

◆ New() [2/2]

Foam::autoPtr< Foam::solidProperties > New ( const dictionary & dict)
static

Return a pointer to a new solidProperties created from dictionary.

Definition at line 50 of file solidPropertiesNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, autoPtr< T >::New(), and Foam::New().

Here is the call graph for this function:

◆ rho()

scalar rho ( ) const
inlinenoexcept

Density [kg/m3].

Definition at line 219 of file solidProperties.H.

References Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), and solidProperties().

Here is the caller graph for this function:

◆ Cp()

scalar Cp ( ) const
inline

Specific heat capacity [J/(kg.K)].

Definition at line 224 of file solidProperties.H.

Referenced by declareRunTimeSelectionTable(), and solidProperties().

Here is the caller graph for this function:

◆ kappa()

scalar kappa ( ) const
inlinenoexcept

Thermal conductivity [W/(m.K)].

Definition at line 229 of file solidProperties.H.

References Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), and solidProperties().

Here is the caller graph for this function:

◆ Hf()

scalar Hf ( ) const
inlinenoexcept

Heat of formation [J/kg].

Definition at line 234 of file solidProperties.H.

References Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), and solidProperties().

Here is the caller graph for this function:

◆ Hs()

Foam::scalar Hs ( const scalar T) const
inline

Sensible enthalpy - reference to Tstd [J/kg].

Definition at line 26 of file solidPropertiesI.H.

References Foam::T(), and Foam::constant::thermodynamic::Tstd.

Here is the call graph for this function:

◆ emissivity()

scalar emissivity ( ) const
inlinenoexcept

Emissivity [].

Definition at line 244 of file solidProperties.H.

References Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), and solidProperties().

Here is the caller graph for this function:

◆ W()

scalar W ( ) const
inlinenoexcept

Molar weight [Kg/Kmol].

Definition at line 249 of file solidProperties.H.

References Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), and solidProperties().

Here is the caller graph for this function:

◆ nu()

scalar nu ( ) const
inlinenoexcept

Poisson ratio.

Definition at line 254 of file solidProperties.H.

References Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), and solidProperties().

Here is the caller graph for this function:

◆ E()

scalar E ( ) const
inlinenoexcept

Young modulus [N/m2].

Definition at line 259 of file solidProperties.H.

References Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), and solidProperties().

Here is the caller graph for this function:

◆ readIfPresent()

void readIfPresent ( const dictionary & dict)

Read and set the properties if present in the given dictionary.

Definition at line 154 of file solidProperties.C.

References dict.

Referenced by ash::ash(), C::C(), and CaCO3::CaCO3().

Here is the caller graph for this function:

◆ writeData()

void writeData ( Ostream & os) const
virtual

Write the solidProperties properties.

Reimplemented in ash, C, and CaCO3.

Definition at line 167 of file solidProperties.C.

References os(), and token::SPACE.

Referenced by ash::writeData(), C::writeData(), and CaCO3::writeData().

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

◆ operator<<

Ostream & operator<< ( Ostream & os,
const solidProperties & s )
friend

Ostream Operator.

References os(), s(), and solidProperties().


The documentation for this class was generated from the following files:
  • src/thermophysicalModels/thermophysicalProperties/solidProperties/solidProperties/solidProperties.H
  • src/thermophysicalModels/thermophysicalProperties/solidProperties/solidProperties/solidProperties.C
  • src/thermophysicalModels/thermophysicalProperties/solidProperties/solidProperties/solidPropertiesI.H
  • src/thermophysicalModels/thermophysicalProperties/solidProperties/solidProperties/solidPropertiesNew.C