Loading...
Searching...
No Matches
specieElement Class Reference

#include <specieElement.H>

Public Member Functions

 specieElement ()
 Default construct.
 specieElement (const word &name, const label nAtoms)
 Construct from components.
 specieElement (Istream &is)
 Construct from Istream.
const word & name () const
 Return the name of the element.
word & name ()
 Return non-const access to the name of the element.
label nAtoms () const
 Return the number of atoms of this element in the specie.
label & nAtoms ()
 Return non-const access to the number of atoms of this element.
bool operator== (const specieElement &) const
 Equality comparison.
bool operator!= (const specieElement &) const
 Inequality comparison.

Friends

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

Detailed Description

Source files

Definition at line 51 of file specieElement.H.

Constructor & Destructor Documentation

◆ specieElement() [1/3]

specieElement ( )
inline

Default construct.

Definition at line 26 of file specieElementI.H.

Referenced by operator!=(), operator<<, and operator==().

Here is the caller graph for this function:

◆ specieElement() [2/3]

specieElement ( const word & name,
const label nAtoms )
inline

Construct from components.

Definition at line 33 of file specieElementI.H.

References name(), and nAtoms().

Here is the call graph for this function:

◆ specieElement() [3/3]

specieElement ( Istream & is)
inlineexplicit

Construct from Istream.

Definition at line 40 of file specieElementI.H.

References Foam::readLabel().

Here is the call graph for this function:

Member Function Documentation

◆ name() [1/2]

const Foam::word & name ( ) const
inline

Return the name of the element.

Definition at line 49 of file specieElementI.H.

Referenced by DAC< CompType, ThermoType >::DAC(), EFA< CompType, ThermoType >::EFA(), Foam::operator<<(), and specieElement().

Here is the caller graph for this function:

◆ name() [2/2]

Foam::word & name ( )
inline

Return non-const access to the name of the element.

Definition at line 55 of file specieElementI.H.

◆ nAtoms() [1/2]

Foam::label nAtoms ( ) const
inline

Return the number of atoms of this element in the specie.

Definition at line 61 of file specieElementI.H.

Referenced by DAC< CompType, ThermoType >::DAC(), EFA< CompType, ThermoType >::EFA(), Foam::operator<<(), and specieElement().

Here is the caller graph for this function:

◆ nAtoms() [2/2]

Foam::label & nAtoms ( )
inline

Return non-const access to the number of atoms of this element.

in the specie

Definition at line 67 of file specieElementI.H.

◆ operator==()

bool operator== ( const specieElement & se) const
inline

Equality comparison.

Definition at line 75 of file specieElementI.H.

References specieElement().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const specieElement & se) const
inline

Inequality comparison.

Definition at line 85 of file specieElementI.H.

References Foam::operator==(), and specieElement().

Here is the call graph for this function:

◆ operator<<

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

References specieElement().

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