Public Types | Public Member Functions | List of all members
reactingMixture< ThermoType > Class Template Reference

Foam::reactingMixture. More...

Inheritance diagram for reactingMixture< ThermoType >:
Inheritance graph
[legend]
Collaboration diagram for reactingMixture< ThermoType >:
Collaboration graph
[legend]

Public Types

typedef ThermoType thermoType
 The type of thermo package this mixture is instantiated for. More...
 
- Public Types inherited from List< word >
typedef SubList< wordsubList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a UList. More...
 
typedef Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Public Types inherited from multiComponentMixture< ThermoType >
typedef ThermoType thermoType
 The type of thermodynamics this mixture is instantiated for. More...
 
- Public Types inherited from basicSpecieMixture
typedef basicSpecieMixture basicMixtureType
 The base class of the mixture. More...
 
- Public Types inherited from basicMultiComponentMixture
typedef basicMultiComponentMixture basicMixtureType
 The base class of the mixture. More...
 
- Public Types inherited from PtrList< Reaction< ThermoType > >
typedef Reaction< ThermoType > value_type
 Type of values the PtrList contains. More...
 
typedef Reaction< ThermoType > & reference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const Reaction< ThermoType > & const_reference
 Type that can be used for storing into constant PtrList::value_type. More...
 

Public Member Functions

 reactingMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 
virtual ~reactingMixture ()
 Destructor. More...
 
void read (const dictionary &)
 Read dictionary. More...
 
label size () const
 
Reaction< ThermoType > & operator[] (const label i)
 
const Reaction< ThermoType > & operator[] (const label i) const
 
- Public Member Functions inherited from hashedWordList
 hashedWordList ()
 Construct null. More...
 
 hashedWordList (const hashedWordList &)
 Copy constructor. More...
 
 hashedWordList (const UList< word > &names)
 Construct from list of names. More...
 
 hashedWordList (const Xfer< List< word > > &names)
 Construct by transferring the parameter contents. More...
 
 hashedWordList (const label nNames, const char **names)
 Construct from number and list of names. More...
 
 hashedWordList (const char **names)
 Construct from a NULL-terminated list of names. More...
 
 hashedWordList (Istream &)
 Construct from Istream. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const word &)
 Append an element at the end of the list. More...
 
bool contains (const word &) const
 Does the list contain the specified name. More...
 
void transfer (List< word > &)
 Transfer the contents of the argument List into this list. More...
 
void operator= (const UList< word > &names)
 Assignment operator from list of names. More...
 
void operator= (const hashedWordList &)
 Assignment operator. More...
 
const wordoperator[] (const label index) const
 Return name corresponding to specified index. More...
 
label operator[] (const word &) const
 Return index corresponding to specified name. More...
 
- Public Member Functions inherited from List< word >
label size () const
 Return the number of elements in the UList. More...
 
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const word &)
 Construct with given size and value for all elements. More...
 
 List (const List< word > &)
 Copy constructor. More...
 
 List (const Xfer< List< word > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< word > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< word > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 List (const FixedList< word, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< word > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< word > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< word > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< word > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< word > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const word &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const word &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const word &)
 Append an element at the end of the list. More...
 
void append (const UList< word > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< word > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< word > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< word, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< word > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< word > > xfer ()
 Transfer contents to the Xfer container. More...
 
wordnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< word > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< word > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< word > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< word > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< word > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const word &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
std::streamsize byteSize () const
 Return the binary size in number of characters of the UList. More...
 
const Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1). More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size). More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1). More...
 
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const
 Return the number of elements in the UList. More...
 
label max_size () const
 Return size of the largest possible UList. More...
 
bool empty () const
 Return true if the UList is empty (ie, size() is zero). More...
 
void swap (UList< T > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time. More...
 
template<>
const bool & operator[] (const label i) const
 
- Public Member Functions inherited from autoPtr< chemistryReader< ThermoType > >
 autoPtr (chemistryReader< ThermoType > *=0)
 Store object pointer. More...
 
 autoPtr (const autoPtr< chemistryReader< ThermoType > > &)
 Construct as copy by transferring pointer to this autoPtr and. More...
 
 autoPtr (const autoPtr< chemistryReader< ThermoType > > &, const bool reUse)
 Construct either by transferring pointer or cloning. Should. More...
 
 ~autoPtr ()
 Destructor, delete object if pointer is not NULL. More...
 
bool empty () const
 Return true if the autoPtr is empty (ie, no pointer set). More...
 
bool valid () const
 Return true if the autoPtr valid (ie, the pointer is set). More...
 
chemistryReader< ThermoType > * ptr ()
 Return object pointer for reuse. More...
 
void set (chemistryReader< ThermoType > *)
 Set pointer to that given. More...
 
void reset (chemistryReader< ThermoType > *=0)
 If object pointer already set, delete object and set to given. More...
 
void clear ()
 Delete object (if the pointer is valid) and set pointer to NULL. More...
 
chemistryReader< ThermoType > & operator() ()
 Return reference to the object data. More...
 
const chemistryReader< ThermoType > & operator() () const
 Return const reference to the object data. More...
 
 operator const chemistryReader< ThermoType > & () const
 Const cast to the underlying type reference. More...
 
chemistryReader< ThermoType > * operator-> ()
 Return object pointer. More...
 
const chemistryReader< ThermoType > * operator-> () const
 Return const object pointer. More...
 
void operator= (const autoPtr< chemistryReader< ThermoType > > &)
 Take over the object pointer from parameter. More...
 
- Public Member Functions inherited from multiComponentMixture< ThermoType >
 multiComponentMixture (const dictionary &, const wordList &specieNames, const HashPtrTable< ThermoType > &thermoData, const fvMesh &, const word &)
 Construct from dictionary, specie names, thermo database,. More...
 
 multiComponentMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 
virtual ~multiComponentMixture ()
 Destructor. More...
 
const ThermoType & cellMixture (const label celli) const
 
const ThermoType & patchFaceMixture (const label patchi, const label facei) const
 
const ThermoType & cellVolMixture (const scalar p, const scalar T, const label celli) const
 
const ThermoType & patchFaceVolMixture (const scalar p, const scalar T, const label patchi, const label facei) const
 
const PtrList< ThermoType > & speciesData () const
 Return the raw specie thermodynamic data. More...
 
void read (const dictionary &)
 Read dictionary. More...
 
const ThermoType & getLocalThermo (const label speciei) const
 Return thermo based on index. More...
 
- Public Member Functions inherited from basicSpecieMixture
 TypeName ("basicSpecieMixture")
 Run time type information. More...
 
 basicSpecieMixture (const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
 Construct from dictionary, species names, mesh and phase name. More...
 
virtual ~basicSpecieMixture ()
 Destructor. More...
 
virtual scalar nMoles (const label speciei) const =0
 Number of moles of the given specie []. More...
 
virtual scalar W (const label speciei) const =0
 Molecular weight of the given specie [kg/kmol]. More...
 
tmp< volScalarFieldW () const
 Molecular weight of the mixture [kg/kmol]. More...
 
virtual scalar Cp (const label speciei, const scalar p, const scalar T) const =0
 Heat capacity at constant pressure [J/(kg K)]. More...
 
virtual scalar Cv (const label speciei, const scalar p, const scalar T) const =0
 Heat capacity at constant volume [J/(kg K)]. More...
 
virtual scalar Ha (const label speciei, const scalar p, const scalar T) const =0
 Absolute enthalpy [J/kg]. More...
 
virtual scalar Hs (const label speciei, const scalar p, const scalar T) const =0
 Sensible enthalpy [J/kg]. More...
 
virtual scalar Hc (const label speciei) const =0
 Chemical enthalpy [J/kg]. More...
 
virtual scalar S (const label speciei, const scalar p, const scalar T) const =0
 Entropy [J/(kg K)]. More...
 
virtual scalar Es (const label speciei, const scalar p, const scalar T) const =0
 Sensible internal energy [J/kg]. More...
 
virtual scalar G (const label speciei, const scalar p, const scalar T) const =0
 Gibbs free energy [J/kg]. More...
 
virtual scalar A (const label speciei, const scalar p, const scalar T) const =0
 Helmholtz free energy [J/kg]. More...
 
virtual scalar mu (const label speciei, const scalar p, const scalar T) const =0
 Dynamic viscosity [kg/m/s]. More...
 
virtual scalar kappa (const label speciei, const scalar p, const scalar T) const =0
 Thermal conductivity [W/m/K]. More...
 
virtual scalar alphah (const label speciei, const scalar p, const scalar T) const =0
 Thermal diffusivity of enthalpy [kg/m/s]. More...
 
virtual scalar rho (const label speciei, const scalar p, const scalar T) const =0
 Density [kg/m3]. More...
 
- Public Member Functions inherited from basicMultiComponentMixture
 TypeName ("basicMultiComponentMixture")
 Run time type information. More...
 
 basicMultiComponentMixture (const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
 Construct from dictionary, species names, mesh and phase name. More...
 
virtual ~basicMultiComponentMixture ()
 Destructor. More...
 
const speciesTablespecies () const
 Return the table of species. More...
 
PtrList< volScalarField > & Y ()
 Return the mass-fraction fields. More...
 
const PtrList< volScalarField > & Y () const
 Return the const mass-fraction fields. More...
 
volScalarFieldY (const label i)
 Return the mass-fraction field for a specie given by index. More...
 
const volScalarFieldY (const label i) const
 Return the const mass-fraction field for a specie given by index. More...
 
volScalarFieldY (const word &specieName)
 Return the mass-fraction field for a specie given by name. More...
 
const volScalarFieldY (const word &specieName) const
 Return the const mass-fraction field for a specie given by name. More...
 
bool contains (const word &specieName) const
 Does the mixture include this specie? More...
 
- Public Member Functions inherited from PtrList< Reaction< ThermoType > >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< Reaction< ThermoType > > &)
 Copy constructor. More...
 
 PtrList (const PtrList< Reaction< ThermoType > > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< Reaction< ThermoType > > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< Reaction< ThermoType > > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< Reaction< ThermoType > > &)
 Construct as copy of SLPtrList<T> More...
 
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
label size () const
 Return the number of elements in the PtrList. More...
 
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero). More...
 
Reaction< ThermoType > & first ()
 Return reference to the first element of the list. More...
 
const Reaction< ThermoType > & first () const
 Return reference to first element of the list. More...
 
Reaction< ThermoType > & last ()
 Return reference to the last element of the list. More...
 
const Reaction< ThermoType > & last () const
 Return reference to the last element of the list. More...
 
void setSize (const label)
 Reset size of PtrList. If extending the PtrList, new entries are. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the. More...
 
void append (Reaction< ThermoType > *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< Reaction< ThermoType > > &)
 
void append (const tmp< Reaction< ThermoType > > &)
 
void transfer (PtrList< Reaction< ThermoType > > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< Reaction< ThermoType > > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< Reaction< ThermoType > > set (const label, Reaction< ThermoType > *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< Reaction< ThermoType > > set (const label, const autoPtr< Reaction< ThermoType > > &)
 
autoPtr< Reaction< ThermoType > > set (const label, const tmp< Reaction< ThermoType > > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const Reaction< ThermoType > & operator[] (const label) const
 Return element const reference. More...
 
Reaction< ThermoType > & operator[] (const label)
 Return element reference. More...
 
const Reaction< ThermoType > * operator() (const label) const
 Return element const pointer. More...
 
PtrList< Reaction< ThermoType > > & operator= (const PtrList< Reaction< ThermoType > > &)
 Assignment. More...
 
iterator begin ()
 Return an iterator to begin traversing the PtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
iterator end ()
 Return an iterator to end traversing the PtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the PtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the PtrList. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from List< word >
static const List< word > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 
- Protected Member Functions inherited from List< word >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 
- Protected Member Functions inherited from PtrList< Reaction< ThermoType > >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 
- Protected Attributes inherited from basicMultiComponentMixture
speciesTable species_
 Table of specie names. More...
 
PtrList< volScalarFieldY_
 Species mass fractions. More...
 

Detailed Description

template<class ThermoType>
class Foam::reactingMixture< ThermoType >

Foam::reactingMixture.

Source files

Definition at line 51 of file reactingMixture.H.

Member Typedef Documentation

typedef ThermoType thermoType

The type of thermo package this mixture is instantiated for.

Definition at line 70 of file reactingMixture.H.

Constructor & Destructor Documentation

reactingMixture ( const dictionary thermoDict,
const fvMesh mesh,
const word phaseName 
)

Construct from dictionary, mesh and phase name.

Definition at line 33 of file reactingMixture.C.

References clear().

Here is the call graph for this function:

virtual ~reactingMixture ( )
inlinevirtual

Destructor.

Definition at line 80 of file reactingMixture.H.

References reactingMixture< ThermoType >::read().

Here is the call graph for this function:

Member Function Documentation

void read ( const dictionary thermoDict)

Read dictionary.

Definition at line 64 of file reactingMixture.C.

Referenced by reactingMixture< ThermoType >::~reactingMixture().

Here is the caller graph for this function:

label size ( ) const
inline

Definition at line 89 of file reactingMixture.H.

Reaction<ThermoType>& operator[] ( const label  i)
inline

Definition at line 94 of file reactingMixture.H.

References PtrList< Reaction< ThermoType > >::operator.

const Reaction<ThermoType>& operator[] ( const label  i) const
inline

Definition at line 99 of file reactingMixture.H.

References PtrList< Reaction< ThermoType > >::operator.


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