FreeFOAM The Cross-Platform CFD Toolkit
reactingMixture< ThermoType > Class Template Reference

Foam::reactingMixture. More...

#include <reactionThermophysicalModels/reactingMixture.H>


Detailed Description

+ Inheritance diagram for reactingMixture< ThermoType >:
+ Collaboration diagram for reactingMixture< ThermoType >:

List of all members.

Public Types

typedef ThermoType thermoType
 The type of thermo package this mixture is instantiated for.
- Public Types inherited from multiComponentMixture< ThermoType >
- Public Types inherited from PtrList< Reaction< ThermoType > >
typedef Reaction< ThermoTypevalue_type
 Type of values the PtrList contains.
typedef Reaction< ThermoType > & reference
 Type that can be used for storing into PtrList::value_type objects.
typedef const Reaction
< ThermoType > & 
const_reference
 Type that can be used for storing into constant PtrList::value_type.

Public Member Functions

 reactingMixture (const dictionary &, const fvMesh &)
 Construct from dictionary and mesh.
virtual ~reactingMixture ()
 Destructor.
void read (const dictionary &)
 Read dictionary.
- Public Member Functions inherited from autoPtr< chemistryReader< ThermoType > >
 autoPtr (chemistryReader< ThermoType > *=0)
 Store object pointer.
 autoPtr (const autoPtr< chemistryReader< ThermoType > > &)
 Construct as copy by transfering pointer to this autoPtr and.
 ~autoPtr ()
 Delete object if pointer is not NULL.
bool empty () const
 Return true if the autoPtr is empty (ie, no pointer set).
bool valid () const
 Return true if the autoPtr valid (ie, the pointer is set).
chemistryReader< ThermoType > * ptr ()
 Return object pointer for reuse.
void set (chemistryReader< ThermoType > *)
 Set pointer to that given.
void reset (chemistryReader< ThermoType > *=0)
 If object pointer already set, delete object and set to given pointer.
void clear ()
 Delete object and set pointer to NULL, if the pointer is valid.
chemistryReader< ThermoType > & operator() ()
 Return reference to the object data.
const chemistryReader
< ThermoType > & 
operator() () const
 Return const reference to the object data.
 operator const chemistryReader< ThermoType > & () const
chemistryReader< ThermoType > * operator-> ()
 Return object pointer.
const chemistryReader
< ThermoType > * 
operator-> () const
 Return const object pointer.
void operator= (const autoPtr< chemistryReader< ThermoType > > &)
 Take over object pointer from parameter.
- Public Member Functions inherited from multiComponentMixture< ThermoType >
 multiComponentMixture (const dictionary &, const wordList &specieNames, const HashPtrTable< ThermoType > &specieThermoData, const fvMesh &)
 Construct from dictionary, specie names, thermo database and mesh.
 multiComponentMixture (const dictionary &, const fvMesh &)
 Construct from dictionary and mesh.
virtual ~multiComponentMixture ()
 Destructor.
const ThermoTypecellMixture (const label celli) const
const ThermoTypepatchFaceMixture (const label patchi, const label facei) const
const PtrList< ThermoType > & speciesData () const
 Return the raw specie thermodynamic data.
- Public Member Functions inherited from basicMultiComponentMixture
 basicMultiComponentMixture (const dictionary &, const wordList &specieNames, const fvMesh &)
 Construct from dictionary and mesh.
virtual ~basicMultiComponentMixture ()
 Destructor.
const speciesTablespecies () const
 Return the table of species.
PtrList< volScalarField > & Y ()
 Return the mass-fraction fields.
const PtrList< volScalarField > & Y () const
 Return the const mass-fraction fields.
volScalarFieldY (const label i)
 Return the mass-fraction field for a specie given by index.
const volScalarFieldY (const label i) const
 Return the const mass-fraction field for a specie given by index.
volScalarFieldY (const word &specieName)
 Return the mass-fraction field for a specie given by name.
const volScalarFieldY (const word &specieName) const
 Return the const mass-fraction field for a specie given by name.
bool contains (const word &specieName) const
 Does the mixture include this specie?
scalar fres (const scalar ft, const scalar stoicRatio) const
tmp< volScalarFieldfres (const volScalarField &ft, const dimensionedScalar &stoicRatio) const
- Public Member Functions inherited from PtrList< Reaction< ThermoType > >
 PtrList ()
 Null Constructor.
 PtrList (const label)
 Construct with length specified.
 PtrList (const PtrList< Reaction< ThermoType > > &)
 Copy constructor.
 PtrList (const PtrList< Reaction< ThermoType > > &, const CloneArg &)
 Copy constructor with additional argument for clone.
 PtrList (const Xfer< PtrList< Reaction< ThermoType > > > &)
 Construct by transferring the parameter contents.
 PtrList (PtrList< Reaction< ThermoType > > &, bool reUse)
 Construct as copy or re-use as specified.
 PtrList (const SLPtrList< Reaction< ThermoType > > &)
 Construct as copy of SLPtrList<T>
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class.
 ~PtrList ()
label size () const
 Return the number of elements in the PtrList.
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero).
void setSize (const label)
 Reset size of PtrList. This can only be used to set the size.
void resize (const label)
 Reset size of PtrList. This can only be used to set the size.
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the.
void transfer (PtrList< Reaction< ThermoType > > &)
 Transfer the contents of the argument PtrList into this PtrList.
Xfer< PtrList< Reaction
< ThermoType > > > 
xfer ()
 Transfer contents to the Xfer container.
bool set (const label) const
 Is element set.
autoPtr< Reaction< ThermoType > > set (const label, Reaction< ThermoType > *)
 Set element. Return old element (can be NULL).
autoPtr< Reaction< ThermoType > > set (const label, const autoPtr< Reaction< ThermoType > > &)
autoPtr< Reaction< ThermoType > > set (const label, const tmp< Reaction< ThermoType > > &)
void reorder (const UList< label > &)
 Reorders elements. Ordering does not have to be done in.
const Reaction< ThermoType > & operator[] (const label) const
 Return element const reference.
Reaction< ThermoType > & operator[] (const label)
 Return element reference.
const Reaction< ThermoType > * operator() (const label) const
 Return element const pointer.
PtrList< Reaction< ThermoType > > & operator= (const PtrList< Reaction< ThermoType > > &)
 Assignment.
iterator begin ()
 Return an iterator to begin traversing the PtrList.
iterator end ()
 Return an iterator to end traversing the PtrList.

Additional Inherited Members

- Protected Member Functions inherited from PtrList< Reaction< ThermoType > >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class.

Member Typedef Documentation

The type of thermo package this mixture is instantiated for.

Reimplemented from multiComponentMixture< ThermoType >.

Definition at line 69 of file reactingMixture.H.


Constructor & Destructor Documentation

reactingMixture ( const dictionary thermoDict,
const fvMesh mesh 
)

Construct from dictionary and mesh.

Definition at line 33 of file reactingMixture.C.

References clear().

virtual ~reactingMixture ( )
inlinevirtual

Destructor.

Definition at line 79 of file reactingMixture.H.


Member Function Documentation

void read ( const dictionary thermoDict)

Read dictionary.

Reimplemented from multiComponentMixture< ThermoType >.

Definition at line 62 of file reactingMixture.C.


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