specie Class Reference

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

Public Member Functions

 ClassName ("specie")
 Declare type-name (with debug switch) More...
 
 specie (const specie &)=default
 Copy construct. 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 wordname () 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 &)
 Copy assignment, preserve original name. More...
 
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 &)
 
Ostreamoperator<< (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/5]

specie ( const specie )
default

Copy construct.

◆ specie() [2/5]

specie ( const scalar  Y,
const scalar  molWeight 
)
inline

Construct from components without name.

Definition at line 46 of file specieI.H.

◆ specie() [3/5]

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

Construct from components with name.

Definition at line 33 of file specieI.H.

References Foam::name().

Here is the call graph for this function:

◆ specie() [4/5]

specie ( const word name,
const specie st 
)
inline

Construct as named copy.

Definition at line 59 of file specieI.H.

◆ specie() [5/5]

specie ( const dictionary dict)
explicit

Construct from dictionary.

Definition at line 42 of file specie.C.

Member Function Documentation

◆ ClassName()

ClassName ( "specie"  )

Declare type-name (with debug switch)

◆ name()

const Foam::word & name ( ) const
inline

Name.

Definition at line 69 of file specieI.H.

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

Here is the caller graph for this function:

◆ W()

Foam::scalar W ( ) const
inline

Molecular weight [kg/kmol].

Definition at line 75 of file specieI.H.

◆ Y()

Foam::scalar Y ( ) const
inline

No of moles of this species in mixture.

Definition at line 81 of file specieI.H.

◆ R()

Foam::scalar R ( ) const
inline

Gas constant [J/(kg K)].

Definition at line 87 of file specieI.H.

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

◆ write()

void write ( Ostream os) const

Write to Ostream.

Definition at line 52 of file specie.C.

References Ostream::beginBlock(), Ostream::endBlock(), os(), 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

Copy assignment, preserve original name.

Definition at line 95 of file specieI.H.

◆ operator+=()

void operator+= ( const specie st)
inline

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

References s().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator+

specie operator+ ( const specie ,
const specie  
)
friend

◆ operator*

specie operator* ( const  scalar,
const specie  
)
friend

◆ operator==

specie operator== ( const specie ,
const specie  
)
friend

◆ operator<<

Ostream & operator<< ( Ostream ,
const specie  
)
friend

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