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 nMoles, const scalar molWeight)
 Construct from components without name. More...
 
 specie (const word &name, const scalar nMoles, const scalar molWeight)
 Construct from components with name. More...
 
 specie (const specie &)
 Construct as copy. More...
 
 specie (const word &name, const specie &)
 Construct as named copy. More...
 
 specie (Istream &)
 Construct from Istream. More...
 
 specie (const dictionary &dict)
 Construct from dictionary. More...
 
const wordname () const
 Name. More...
 
scalar W () const
 Molecular weight [kg/kmol]. More...
 
scalar nMoles () 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 specie &)
 
void operator*= (const scalar)
 

Friends

specie operator+ (const specie &, const specie &)
 
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 57 of file specie.H.

Constructor & Destructor Documentation

specie ( const scalar  nMoles,
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 ( const word name,
const scalar  nMoles,
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 ( const specie st)
inline

Construct as copy.

Definition at line 61 of file specieI.H.

specie ( const word name,
const specie st 
)
inline

Construct as named copy.

Definition at line 69 of file specieI.H.

specie ( Istream is)

Construct from Istream.

Definition at line 40 of file specie.C.

References IOstream::check().

Here is the call graph for this function:

specie ( const dictionary dict)

Construct from dictionary.

Definition at line 50 of file specie.C.

Member Function Documentation

ClassName ( "specie"  )

Runtime type information.

const word & name ( ) const
inline

Name.

Definition at line 79 of file specieI.H.

Referenced by sutherlandTransport< Thermo >::write().

Here is the caller graph for this function:

scalar W ( ) const
inline

Molecular weight [kg/kmol].

Definition at line 85 of file specieI.H.

scalar nMoles ( ) const
inline

No of moles of this species in mixture.

Definition at line 91 of file specieI.H.

scalar R ( ) const
inline

Gas constant [J/(kg K)].

Definition at line 97 of file specieI.H.

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

void write ( Ostream os) const

Write to Ostream.

Definition at line 60 of file specie.C.

References dictionary::add(), IOstream::check(), dict, dictionaryName::dictName(), Foam::indent(), Foam::operator<<(), and Foam::tab.

Here is the call graph for this function:

void operator= ( const specie st)
inline

Definition at line 105 of file specieI.H.

void operator+= ( const specie st)
inline

Definition at line 113 of file specieI.H.

References Foam::max().

Here is the call graph for this function:

void operator-= ( const specie st)
inline

Definition at line 125 of file specieI.H.

References Foam::mag().

Here is the call graph for this function:

void operator*= ( const scalar  s)
inline

Definition at line 141 of file specieI.H.

References s().

Here is the call graph for this function:

Friends And Related Function Documentation

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

Definition at line 149 of file specieI.H.

specie operator- ( const specie st1,
const specie st2 
)
friend

Definition at line 162 of file specieI.H.

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

Definition at line 179 of file specieI.H.

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

Definition at line 189 of file specieI.H.

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

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