Loading...
Searching...
No Matches
specie Class Reference

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

#include <specie.H>

Public Member Functions

 ClassName ("specie")
 Declare type-name (with debug switch).
 specie (const specie &)=default
 Copy construct.
 specie (const scalar Y, const scalar molWeight)
 Construct from components without name.
 specie (const word &name, const scalar Y, const scalar molWeight)
 Construct from components with name.
 specie (const word &name, const specie &)
 Construct as named copy.
 specie (const dictionary &dict)
 Construct from dictionary.
const word & name () const
 Name.
scalar W () const
 Molecular weight [kg/kmol].
scalar Y () const
 No of moles of this species in mixture.
scalar R () const
 Gas constant [J/(kg K)].
void write (Ostream &os) const
 Write to Ostream.
void operator= (const specie &)
 Copy assignment, preserve original name.
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 63 of file specie.H.

Constructor & Destructor Documentation

◆ specie() [1/5]

specie ( const specie & )
default

Copy construct.

References dict, name(), os(), specie(), and Y().

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

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

◆ specie() [2/5]

specie ( const scalar Y,
const scalar molWeight )
inline

Construct from components without name.

Definition at line 39 of file specieI.H.

References Y().

Here is the call graph for this function:

◆ specie() [3/5]

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

Construct from components with name.

Definition at line 26 of file specieI.H.

References name(), and Y().

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

References name(), and specie().

Here is the call graph for this function:

◆ specie() [5/5]

specie ( const dictionary & dict)
explicit

Construct from dictionary.

Definition at line 35 of file specie.C.

References dict, and dictName().

Here is the call graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "specie" )

Declare type-name (with debug switch).

◆ name()

const Foam::word & name ( ) const
inline

Name.

Definition at line 62 of file specieI.H.

Referenced by specie(), specie(), specie(), 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 68 of file specieI.H.

◆ Y()

Foam::scalar Y ( ) const
inline

No of moles of this species in mixture.

Definition at line 74 of file specieI.H.

Referenced by specie(), specie(), and specie().

Here is the caller graph for this function:

◆ R()

Foam::scalar R ( ) const
inline

Gas constant [J/(kg K)].

Definition at line 80 of file specieI.H.

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

◆ write()

void write ( Ostream & os) const

Write to Ostream.

Definition at line 45 of file specie.C.

References os().

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

References specie().

Here is the call graph for this function:

◆ operator+=()

void operator+= ( const specie & st)
inline

Definition at line 96 of file specieI.H.

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

Here is the call graph for this function:

◆ operator*=()

void operator*= ( const scalar s)
inline

Definition at line 108 of file specieI.H.

References s().

Here is the call graph for this function:

◆ operator+

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

References specie().

◆ operator*

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

References specie().

◆ operator==

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

References specie().

◆ operator<<

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

References specie().

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