Public Member Functions | Friends | List of all members
specie Class Reference

Base class of the thermophysical property types. More...

Public Member Functions

 ClassName ("specie")
 Runtime type information. More...
 
 specie (const scalar Y, const scalar molWeight)
 Construct from components without name. More...
 
 specie (const word &name, const scalar Y, const scalar molWeight)
 Construct from components with name. More...
 
 specie (const word &name, const specie &)
 Construct as named copy. More...
 
 specie (const dictionary &dict)
 Construct from dictionary. More...
 
 specie (const specie &)=default
 Copy constructor. More...
 
const word & name () const
 Name. More...
 
scalar W () const
 Molecular weight [kg/kmol]. More...
 
scalar Y () const
 Mass fraction of this specie in mixture. More...
 
scalar R () const
 Gas constant [J/kg/K]. More...
 
void write (Ostream &os) const
 Write to Ostream. More...
 
void operator= (const specie &)
 
void operator+= (const specie &)
 
void operator*= (const scalar)
 

Friends

specie operator+ (const specie &, const specie &)
 
specie operator* (const scalar, const specie &)
 
specie operator== (const specie &, const specie &)
 
Ostream & operator<< (Ostream &, const specie &)
 

Detailed Description

Base class of the thermophysical property types.

Source files

Definition at line 65 of file specie.H.

Constructor & Destructor Documentation

◆ specie() [1/5]

specie ( const scalar  Y,
const scalar  molWeight 
)
inline

Construct from components without name.

Definition at line 49 of file specieI.H.

Referenced by Foam::operator*(), Foam::operator+(), Foam::operator==(), and specie::specie().

Here is the caller graph for this function:

◆ specie() [2/5]

specie ( const word &  name,
const scalar  Y,
const scalar  molWeight 
)
inline

Construct from components with name.

Definition at line 36 of file specieI.H.

References specie::specie().

Here is the call graph for this function:

◆ specie() [3/5]

specie ( const word &  name,
const specie &  st 
)
inline

Construct as named copy.

Definition at line 61 of file specieI.H.

◆ specie() [4/5]

specie ( const dictionary &  dict)

Construct from dictionary.

Definition at line 39 of file specie.C.

◆ specie() [5/5]

specie ( const specie &  )
default

Copy constructor.

Member Function Documentation

◆ ClassName()

ClassName ( "specie"  )

Runtime type information.

◆ name()

const word & name ( ) const
inline

Name.

Definition at line 71 of file specieI.H.

Referenced by sutherlandTransport< Thermo >::write(), and WLFTransport< Thermo >::write().

Here is the caller graph for this function:

◆ W()

scalar W ( ) const
inline

Molecular weight [kg/kmol].

Definition at line 77 of file specieI.H.

◆ Y()

scalar Y ( ) const
inline

Mass fraction of this specie in mixture.

Definition at line 83 of file specieI.H.

◆ R()

scalar R ( ) const
inline

Gas constant [J/kg/K].

Definition at line 89 of file specieI.H.

References Foam::constant::physicoChemical::RR.

◆ write()

void write ( Ostream &  os) const

Write to Ostream.

Definition at line 49 of file specie.C.

References dictionary::add(), dict, dictionaryName::dictName(), and Foam::indent().

Referenced by Foam::operator<<().

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

◆ operator=()

void operator= ( const specie &  st)
inline

Definition at line 97 of file specieI.H.

◆ operator+=()

void operator+= ( const specie &  st)
inline

Definition at line 105 of file specieI.H.

References Foam::mag().

Here is the call graph for this function:

◆ operator*=()

void operator*= ( const scalar  s)
inline

Definition at line 117 of file specieI.H.

References s().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator+

specie operator+ ( const specie &  st1,
const specie &  st2 
)
friend

Definition at line 125 of file specieI.H.

◆ operator*

specie operator* ( const scalar  s,
const specie &  st 
)
friend

Definition at line 144 of file specieI.H.

◆ operator==

specie operator== ( const specie &  st1,
const specie &  st2 
)
friend

Definition at line 154 of file specieI.H.

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const specie &   
)
friend
The documentation for this class was generated from the following files: