specie Class Reference

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

Collaboration diagram for specie:

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 word &	name () 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)

Private Attributes
word	name_
	Name of specie. More...
scalar	nMoles_
	Number of moles of this component in the mixture. More...
scalar	molWeight_
	Molecular weight of specie [kg/kmol]. More...

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 &)
Ostream &	operator<< (Ostream &, const specie &)

Detailed Description

Base class of the thermophysical property types.

Source files

• specie.H
• specieI.H
• specie.C

Definition at line 57 of file specie.H.

Constructor & Destructor Documentation

specie() [1/6]

specie ( const scalar  nMoles, const scalar  molWeight  )

inline

Construct from components without name.

Definition at line 49 of file specieI.H.

specie() [2/6]

specie ( const word &  name, const scalar  nMoles, const scalar  molWeight  )

inline

Construct from components with name.

Definition at line 36 of file specieI.H.

specie() [3/6]

specie ( const specie &  st )

inline

Construct as copy.

Definition at line 61 of file specieI.H.

specie() [4/6]

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

inline

Construct as named copy.

Definition at line 69 of file specieI.H.

specie() [5/6]

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() [6/6]

specie

(

const dictionary &

dict

)

Construct from dictionary.

Definition at line 50 of file specie.C.

Member Function Documentation

ClassName()

ClassName

(

"specie"

)

Runtime type information.

name()

const word & name ( ) const

inline

Name.

Definition at line 79 of file specieI.H.

References specie::name_.

Referenced by sutherlandTransport::write().

Here is the caller graph for this function:

W()

scalar W ( ) const

inline

Molecular weight [kg/kmol].

Definition at line 85 of file specieI.H.

References specie::molWeight_.

nMoles()

scalar nMoles ( ) const

inline

No of moles of this species in mixture.

Definition at line 91 of file specieI.H.

References specie::nMoles_.

R()

scalar R ( ) const

inline

Gas constant [J/(kg K)].

Definition at line 97 of file specieI.H.

References specie::molWeight_, and Foam::constant::thermodynamic::RR.

write()

void write

(

Ostream &

os

)

const

Write to Ostream.

Definition at line 60 of file specie.C.

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

Here is the call graph for this function:

operator=()

void operator= ( const specie &  st )

inline

Definition at line 105 of file specieI.H.

References specie::molWeight_, and specie::nMoles_.

operator+=()

void operator+= ( const specie &  st )

inline

Definition at line 113 of file specieI.H.

References Foam::max(), specie::molWeight_, and specie::nMoles_.

Here is the call graph for this function:

operator-=()

void operator-= ( const specie &  st )

inline

Definition at line 125 of file specieI.H.

References Foam::mag(), specie::molWeight_, and specie::nMoles_.

Here is the call graph for this function:

operator*=()

void operator*= ( const scalar  s )

inline

Definition at line 141 of file specieI.H.

References specie::nMoles_, and 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 149 of file specieI.H.

operator-

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

friend

Definition at line 162 of file specieI.H.

operator*

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

friend

Definition at line 179 of file specieI.H.

operator==

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

friend

Definition at line 189 of file specieI.H.

operator<<

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

friend

Field Documentation

name_

word name_

private

Name of specie.

Definition at line 62 of file specie.H.

Referenced by specie::name().

nMoles_

scalar nMoles_

private

Number of moles of this component in the mixture.

Definition at line 65 of file specie.H.

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

molWeight_

scalar molWeight_

private

Molecular weight of specie [kg/kmol].

Definition at line 68 of file specie.H.

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

---

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

• src/thermophysicalModels/specie/specie/specie.H
• src/thermophysicalModels/specie/specie/specie.C
• src/thermophysicalModels/specie/specie/specieI.H