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...
 
const word & name () const
 Name. More...
 
scalar W () const
 Molecular weight [kg/kmol]. More...
 
scalar Y () const
 No of moles of this species 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 67 of file specie.H.

Constructor & Destructor Documentation

◆ specie() [1/4]

specie ( const scalar  Y,
const scalar  molWeight 
)
inline

Construct from components without name.

Definition at line 51 of file specieI.H.

◆ specie() [2/4]

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

Construct from components with name.

Definition at line 38 of file specieI.H.

◆ specie() [3/4]

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

Construct as named copy.

Definition at line 63 of file specieI.H.

◆ specie() [4/4]

specie ( const dictionary &  dict)

Construct from dictionary.

Definition at line 41 of file specie.C.

Member Function Documentation

◆ ClassName()

ClassName ( "specie"  )

Runtime type information.

◆ name()

const word & name ( ) const
inline

Name.

Definition at line 73 of file specieI.H.

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

Here is the caller graph for this function:

◆ W()

scalar W ( ) const
inline

Molecular weight [kg/kmol].

Definition at line 79 of file specieI.H.

◆ Y()

scalar Y ( ) const
inline

No of moles of this species in mixture.

Definition at line 85 of file specieI.H.

◆ R()

scalar R ( ) const
inline

Gas constant [J/(kg K)].

Definition at line 91 of file specieI.H.

References Foam::constant::thermodynamic::RR.

◆ write()

void write ( Ostream &  os) const

Write to Ostream.

Definition at line 51 of file specie.C.

References Ostream::beginBlock(), Ostream::endBlock(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

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 99 of file specieI.H.

◆ operator+=()

void operator+= ( const specie &  st)
inline

Definition at line 107 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 119 of file specieI.H.

References s.

Friends And Related Function Documentation

◆ operator+

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

Definition at line 127 of file specieI.H.

◆ operator*

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

Definition at line 146 of file specieI.H.

◆ operator==

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

Definition at line 156 of file specieI.H.

◆ operator<<

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