singleStepReactingMixture< ThermoType > Class Template Reference

Single step reacting mixture. More...

Inheritance diagram for singleStepReactingMixture< ThermoType >:
[legend]
Collaboration diagram for singleStepReactingMixture< ThermoType >:
[legend]

Public Types

typedef ThermoType thermoType
 The type of thermo package this mixture is instantiated for. More...
 
- Public Types inherited from reactingMixture< ThermoType >
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
 The value type the list contains. More...
 
typedef Tpointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Tconst_pointer
 The pointer type for const access to value_type items. More...
 
typedef Treference
 The type used for storing into value_type objects. More...
 
typedef const Tconst_reference
 The type used for reading from constant value_type objects. More...
 
typedef Titerator
 Random access iterator for traversing a UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing a UList. More...
 
typedef label size_type
 The type to represent the size of a UList. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) 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 basicMixture
typedef basicMixture basicMixtureType
 The base class of the mixture. More...
 
- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the list contains. More...
 
typedef Treference
 A non-const reference to the value_type. More...
 
typedef const Tconst_reference
 A const reference to the value_type. More...
 

Public Member Functions

 singleStepReactingMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 
virtual ~singleStepReactingMixture ()=default
 Destructor. More...
 
void fresCorrect ()
 Calculates the residual for all components. More...
 
const dimensionedScalar stoicRatio () const
 Return the stoichiometric air-fuel mass ratio. More...
 
const dimensionedScalar s () const
 Return the Stoichiometric oxygen-fuel mass ratio. More...
 
const dimensionedScalar qFuel () const
 Return the heat of combustion [J/Kg]. More...
 
const List< scalar > & specieStoichCoeffs () const
 Return the stoichiometric coefficient for the reaction. More...
 
tmp< volScalarFieldfres (const label index) const
 Return the list of components residual. More...
 
label inertIndex () const
 Return the inert specie index. More...
 
label fuelIndex () const
 Return the fuel specie index. More...
 
const List< int > & specieProd () const
 Return the list to indicate if specie is produced/consumed. More...
 
const scalarListYprod0 () const
 Return the list of products mass concentrations. More...
 
void read (const dictionary &)
 Read dictionary. More...
 
- Public Member Functions inherited from reactingMixture< ThermoType >
 reactingMixture (const dictionary &thermoDict, const fvMesh &mesh, const word &phaseName)
 Construct from dictionary, mesh and phase name. More...
 
virtual ~reactingMixture ()=default
 Destructor. More...
 
void read (const dictionary &)
 Read dictionary. More...
 
virtual autoPtr< speciesCompositionTablespecieComposition () const
 Table of species composition. More...
 
- Public Member Functions inherited from hashedWordList
 hashedWordList ()=default
 Default construct an empty list. More...
 
 hashedWordList (const hashedWordList &list)
 Copy construct. More...
 
 hashedWordList (hashedWordList &&list)
 Move construct. More...
 
 hashedWordList (const wordUList &list)
 Copy construct from list of words. More...
 
 hashedWordList (const wordUList &list, bool unique)
 Copy construct from list of words, eliminating duplicates. More...
 
 hashedWordList (wordList &&list, bool unique=false)
 Move construct from list of words, optionally eliminating duplicates. More...
 
 hashedWordList (std::initializer_list< word > list)
 Construct from an initializer list. More...
 
template<class AnyType , class AnyHash >
 hashedWordList (const HashTable< AnyType, word, AnyHash > &tbl)
 Construct from the word keys of any HashTable, sorting immediately. More...
 
 hashedWordList (Istream &is)
 Construct from Istream. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const word &val)
 Append an element if not already in the list. More...
 
label appendUniq (const word &val)
 Append an element if not already in the list. More...
 
const HashTable< label > & lookup () const
 Return the hash of words/indices for inspection. More...
 
void swap (hashedWordList &list)
 Swap contents. More...
 
void transfer (hashedWordList &list)
 
void transfer (wordList &list, bool unique=false)
 
void rehash () const
 Rebuild the lookup hash indices. More...
 
void rehash (bool unique)
 Rebuild the lookup hash indices, or make unique entries first. More...
 
void uniq ()
 
void sort ()
 Inplace sort list and rehash the indices. More...
 
label find (const word &val) const
 Find index of the value (searches the hash). More...
 
bool found (const word &val) const
 True if the value if found in the list (searches the hash). More...
 
const wordoperator[] (const label index) const
 Return name corresponding to specified index. More...
 
label operator[] (const word &val) const
 Find index of the value (searches the hash) - same as find(). More...
 
bool operator() (const word &val) const
 Check hashed values for the specified name - same as found(). More...
 
void operator= (const hashedWordList &list)
 Copy assignment. Rehashes the indices. More...
 
void operator= (const wordUList &list)
 Copy assignment from list of words. Rehashes the indices. More...
 
void operator= (std::initializer_list< word > list)
 Copy assignment from initializer list. Rehashes the indices. More...
 
void operator= (hashedWordList &&list)
 Move assignment operator. More...
 
void operator= (wordList &&list)
 Move assignment from list of words. Rehashes the indices. More...
 
bool contains (const word &val) const
 Deprecated(2019-01) Is the specified name found in the list? More...
 
- Public Member Functions inherited from List< word >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const word &val)
 Construct with given size and value for all elements. More...
 
 List (const label len, const Foam::zero)
 Construct with given size initializing all elements to zero. More...
 
 List (const Foam::one, const word &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, word &&val)
 Construct with length=1, moving the value as the only content. More...
 
 List (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 List (const List< word > &a)
 Copy construct from list. More...
 
 List (const UList< word > &a)
 Copy construct contents from list. More...
 
 List (List< word > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< word > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< word > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< word, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< word > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< word > &list)
 Construct as copy of SLList<T> More...
 
 List (const IndirectListBase< word, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< word > list)
 Construct from an initializer list. More...
 
 List (List< word > &&list)
 Move construct from List. More...
 
 List (DynamicList< word, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SLList< word > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< word > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void resize (const label len)
 Adjust allocated size of list. More...
 
void resize (const label len, const word &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newLen)
 
void resize_nocopy (const label len)
 Adjust allocated size of list without necessarily. More...
 
void setSize (const label n)
 Alias for resize() More...
 
void setSize (const label n, const word &val)
 Alias for resize() More...
 
void append (const word &val)
 Append an element at the end of the list. More...
 
void append (word &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< word > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< word, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const word &val)
 Append an element if not already in the list. More...
 
void transfer (List< word > &list)
 
void transfer (DynamicList< word, SizeMin > &list)
 
wordnewElmt (const label i)
 
void operator= (const UList< word > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< word > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< word > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const IndirectListBase< word, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< word, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< word > list)
 Assignment to an initializer list. More...
 
void operator= (const word &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
void operator= (List< word > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< word, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< word > &&list)
 Move assignment. Takes constant time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
IstreamreadList (Istream &is)
 
IstreamreadList (Istream &is)
 
void shallowCopy (const UList< word > &)=delete
 No shallowCopy permitted. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type set (const label i, bool val=true)
 A bitSet::set() method for a list of bool. More...
 
- Public Member Functions inherited from UList< T >
 UList (const UList< T > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (T *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
label fcIndex (const label i) const noexcept
 
label rcIndex (const label i) const noexcept
 
const TfcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
TfcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const TrcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
TrcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const Tcdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Tdata () noexcept
 Return pointer to the underlying array serving as data storage. More...
 
const char * cdata_bytes () const noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
char * data_bytes () noexcept
 Return pointer to the underlying array serving as data storage,. 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...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 
void checkStart (const label start) const
 Check start is within valid range [0,size) More...
 
void checkSize (const label size) const
 Check size is within valid range [0,size]. More...
 
void checkRange (const label start, const label len) const
 Check that start and length define a valid range. More...
 
void checkIndex (const label i) const
 Check index is within valid range [0,size) More...
 
bool uniform () const
 True if all entries have identical values, and list is non-empty. More...
 
label find (const T &val, label pos=0) const
 Find index of the first occurrence of the value. More...
 
label rfind (const T &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
bool found (const T &val, label pos=0) const
 True if the value if found in the list. More...
 
void moveFirst (const label i)
 Move element to the first position. More...
 
void moveLast (const label i)
 Move element to the last position. More...
 
void swapFirst (const label i)
 Swap element with the first element. Fatal on an empty list. More...
 
void swapLast (const label i)
 Swap element with the last element. Fatal on an empty list. More...
 
void shallowCopy (const UList< T > &list)
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< T > &list)
 Copy elements of the given UList. Sizes must match! More...
 
template<class Addr >
void deepCopy (const IndirectListBase< T, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< Tslice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< Tslice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< Tslice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< Tslice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
Toperator[] (const label i)
 Return element of UList. More...
 
const Toperator[] (const label i) 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 &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const noexcept
 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 noexcept
 The number of elements in the UList. More...
 
bool empty () const noexcept
 True if the UList is empty (ie, size() is zero) More...
 
void swap (UList< T > &list)
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< T > &a) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &a) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &a) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &a) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &a) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 
IstreamreadList (Istream &is)
 
OstreamwriteList (Ostream &os, const label) const
 
const booloperator[] (const label i) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
OstreamwriteList (Ostream &os, const label) const
 
IstreamreadList (Istream &is)
 
- Public Member Functions inherited from multiComponentMixture< ThermoType >
 multiComponentMixture (const dictionary &, const wordList &specieNames, const ReactionTable< ThermoType > &thermoData, const fvMesh &mesh, const word &phaseName)
 
 multiComponentMixture (const dictionary &thermoDict, const fvMesh &mesh, const word &phaseName)
 Construct from dictionary, mesh and phase name. More...
 
virtual ~multiComponentMixture ()=default
 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 &thermoDict, const wordList &specieNames, const fvMesh &mesh, const word &phaseName)
 Construct from dictionary, species names, mesh and phase name. More...
 
virtual ~basicSpecieMixture ()=default
 Destructor. More...
 
virtual scalar W (const label speciei) const =0
 Molecular weight of the given specie [kg/kmol]. More...
 
virtual scalar Hc (const label speciei) const =0
 Chemical enthalpy [J/kg]. 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 HE (const label speciei, const scalar p, const scalar T) const =0
 Enthalpy/Internal energy [J/kg]. 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 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...
 
virtual autoPtr< speciesCompositionTablespecieComposition () const
 Species composition. More...
 
- Public Member Functions inherited from basicMultiComponentMixture
 TypeName ("basicMultiComponentMixture")
 Run time type information. More...
 
 basicMultiComponentMixture (const dictionary &thermoDict, const wordList &specieNames, const fvMesh &mesh, const word &phaseName)
 Construct from dictionary, species names, mesh and phase name. More...
 
virtual ~basicMultiComponentMixture ()=default
 Destructor. More...
 
const speciesTablespecies () const
 Return the table of species. More...
 
bool contains (const word &specieName) const
 Does the mixture include this specie? More...
 
bool active (label speciei) const
 Return true for active species. More...
 
const List< bool > & active () const
 Return the bool list of active species. More...
 
void setActive (label speciei)
 Set speciei active. More...
 
void setInactive (label speciei)
 Set speciei inactive. 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...
 
- Public Member Functions inherited from basicMixture
 basicMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 
- Public Member Functions inherited from PtrList< Reaction< ThermoType > >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< Reaction< ThermoType > > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< Reaction< ThermoType > > &&list)
 Move construct. More...
 
 PtrList (UList< Reaction< ThermoType > * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< Reaction< ThermoType > > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< Reaction< ThermoType > > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< Reaction< ThermoType > > &list)
 Copy construct using 'clone()' on each element of SLPtrList<T> More...
 
 PtrList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
PtrList< Reaction< ThermoType > > clone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< Reaction< ThermoType > > clone (Args &&... args) const
 
const Reaction< ThermoType > * set (const label i) const
 
autoPtr< Reaction< ThermoType > > set (const label i, Reaction< ThermoType > *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< Reaction< ThermoType > > set (const label i, autoPtr< Reaction< ThermoType > > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< Reaction< ThermoType > > set (const label i, autoPtr< Reaction< ThermoType > > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< Reaction< ThermoType > > set (const label i, std::unique_ptr< Reaction< ThermoType > > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< Reaction< ThermoType > > set (const label i, const refPtr< Reaction< ThermoType > > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< Reaction< ThermoType > > set (const label i, const tmp< Reaction< ThermoType > > &ptr)
 Set element to given tmp and return old element. More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void emplace_append (Args &&... args)
 Construct and append an element to the end of the list. More...
 
void append (Reaction< ThermoType > *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< Reaction< ThermoType > > &ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< Reaction< ThermoType > > &&ptr)
 Move append an element to the end of the list. More...
 
void append (std::unique_ptr< Reaction< ThermoType > > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< Reaction< ThermoType > > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void append (const tmp< Reaction< ThermoType > > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
void append (PtrList< Reaction< ThermoType > > &&other)
 Move append another list to the end of this list. More...
 
autoPtr< Reaction< ThermoType > > emplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< Reaction< ThermoType > > emplace (const label i, Args &&... args)
 
autoPtr< Reaction< ThermoType > > release (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< Reaction< ThermoType > > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< Reaction< ThermoType > > &list)
 Copy assignment. More...
 
void operator= (PtrList< Reaction< ThermoType > > &&list)
 Move assignment. More...
 
- Public Member Functions inherited from UPtrList< T >
constexpr UPtrList () noexcept
 Default construct. More...
 
 UPtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 UPtrList (const UPtrList< T > &list)
 Copy construct (shallow copies addresses) More...
 
 UPtrList (UPtrList< T > &&list)
 Move construct. More...
 
 UPtrList (UPtrList< T > &list, bool reuse)
 Construct as shallow copy or re-use as specified. More...
 
 UPtrList (PtrList< T > &list)
 Shallow copy from PtrList. More...
 
 UPtrList (const UList< T * > &list)
 Construct from UList of pointers (shallow copy) More...
 
 UPtrList (UList< T > &list)
 Construct from UList, taking the address of each list element. More...
 
label size () const noexcept
 The number of elements in the list. More...
 
bool empty () const noexcept
 True if the list is empty (ie, size() is zero) More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
const Ttest (const label i) const
 
Tget (const label i)
 
const Tget (const label i) const
 
const Tset (const label i) const
 
void clear ()
 Set list size to zero. More...
 
void resize (const label newLen)
 Change the size of the list. More...
 
void setSize (const label n)
 Alias for resize() More...
 
label squeezeNull ()
 Squeeze out intermediate nullptr entries in the list of pointers. More...
 
void append (T *ptr)
 Append an element to the end of the list. More...
 
void append (UPtrList< T > &&other)
 Move append another list to the end of this list. More...
 
void swap (UPtrList< T > &list)
 Swap content. More...
 
void transfer (UPtrList< T > &list)
 Transfer contents into this list and annul the argument. More...
 
Tset (const label i, T *ptr)
 
void reorder (const labelUList &oldToNew, const bool check=false)
 
void sortOrder (const labelUList &order, const bool check=false)
 
void checkNonNull () const
 Check and raise FatalError if any nullptr exists in the list. More...
 
const Toperator[] (const label i) const
 Return const reference to the element. More...
 
Toperator[] (const label i)
 Return reference to the element. More...
 
const Toperator() (const label i) const
 Return const pointer to the element - same as get(). More...
 
void operator= (const UPtrList< T > &list)
 Copy assignment (shallow copies addresses) More...
 
void operator= (UPtrList< T > &&list)
 Move assignment. More...
 
T ** begin_ptr () noexcept
 Iterator to begin of raw pointers traversal (use with caution) More...
 
T ** end_ptr () noexcept
 Iterator beyond end of raw pointers traversal (use with caution) More...
 
iterator begin () noexcept
 Return an iterator to begin of UPtrList traversal. More...
 
iterator end () noexcept
 Return iterator beyond end of UPtrList traversal. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator cend () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator end () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 

Static Public Member Functions

static word typeName ()
 Return the instantiated type name. More...
 
- Static Public Member Functions inherited from reactingMixture< ThermoType >
static word typeName ()
 Return the instantiated type name. More...
 
- 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 UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 
- Static Public Member Functions inherited from multiComponentMixture< ThermoType >
static word typeName ()
 Return the instantiated type name. More...
 

Protected Member Functions

void calculateqFuel ()
 Calculate qFuel. More...
 
void massAndAirStoichRatios ()
 Calculate air/fuel and oxygen/fuel ratio. More...
 
void calculateMaxProducts ()
 Calculate maximum products at stoichiometric mixture. More...
 
- Protected Member Functions inherited from UList< T >
void setAddressableSize (const label n) noexcept
 Set addressed size to be inconsistent with allocated storage. More...
 
void size (const label n)
 Older name for setAddressableSize. More...
 
void writeEntry (Ostream &os) const
 Write the UList with its compound type. More...
 
labelRange validateRange (const labelRange &requestedRange) const
 
UList< T > & operator= (const UList< T > &)=delete
 No copy assignment (default: shallow copy) More...
 
void writeEntry (Ostream &os) const
 
void writeEntry (Ostream &os) const
 
- Protected Member Functions inherited from PtrList< Reaction< ThermoType > >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class. More...
 
void free ()
 Delete the allocated entries, but retain the list size. More...
 
- Protected Member Functions inherited from UPtrList< T >
void setAddressableSize (const label n) noexcept
 Adjust addressable size. More...
 
 UPtrList (Detail::PtrListDetail< T > &&ptrs)
 Low-level move construct. More...
 

Protected Attributes

dimensionedScalar stoicRatio_
 Stoichiometric air-fuel mass ratio. More...
 
dimensionedScalar s_
 Stoichiometric oxygen-fuel mass ratio. More...
 
dimensionedScalar qFuel_
 Heat of combustion [J/Kg]. More...
 
scalarList specieStoichCoeffs_
 Stoichiometric coefficient for the reaction. More...
 
scalarList Yprod0_
 Mass concentrations at stoichiometric mixture for fres. More...
 
PtrList< volScalarFieldfres_
 List of components residual. More...
 
label inertIndex_
 Inert specie index. More...
 
label fuelIndex_
 Fuel specie index. More...
 
List< int > specieProd_
 List to indicate if specie is produced/consumed. More...
 
- Protected Attributes inherited from basicMultiComponentMixture
speciesTable species_
 Table of specie names. More...
 
List< boolactive_
 List of specie active flags. More...
 
PtrList< volScalarFieldY_
 Species mass fractions. More...
 
- Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< Tptrs_
 The list of pointers. More...
 

Detailed Description

template<class ThermoType>
class Foam::singleStepReactingMixture< ThermoType >

Single step reacting mixture.

Source files

Definition at line 55 of file singleStepReactingMixture.H.

Member Typedef Documentation

◆ thermoType

typedef ThermoType thermoType

The type of thermo package this mixture is instantiated for.

Definition at line 118 of file singleStepReactingMixture.H.

Constructor & Destructor Documentation

◆ singleStepReactingMixture()

◆ ~singleStepReactingMixture()

virtual ~singleStepReactingMixture ( )
virtualdefault

Destructor.

Member Function Documentation

◆ calculateqFuel()

void calculateqFuel
protected

Calculate qFuel.

Definition at line 34 of file singleStepReactingMixture.C.

References Foam::endl(), forAll, Foam::Info, and reaction.

Referenced by singleStepReactingMixture< ThermoType >::singleStepReactingMixture().

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

◆ massAndAirStoichRatios()

void massAndAirStoichRatios
protected

Calculate air/fuel and oxygen/fuel ratio.

Definition at line 61 of file singleStepReactingMixture.C.

References Foam::endl(), Foam::Info, and Foam::mag().

Referenced by singleStepReactingMixture< ThermoType >::singleStepReactingMixture().

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

◆ calculateMaxProducts()

void calculateMaxProducts
protected

Calculate maximum products at stoichiometric mixture.

Definition at line 85 of file singleStepReactingMixture.C.

References forAll, Foam::Info, Foam::mag(), Foam::nl, and reaction.

Referenced by singleStepReactingMixture< ThermoType >::singleStepReactingMixture().

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

◆ typeName()

static word typeName ( )
inlinestatic

Return the instantiated type name.

Definition at line 139 of file singleStepReactingMixture.H.

◆ fresCorrect()

void fresCorrect

Calculates the residual for all components.

Definition at line 135 of file singleStepReactingMixture.C.

References forAll, max(), reaction, and Y.

Here is the call graph for this function:

◆ stoicRatio()

const Foam::dimensionedScalar stoicRatio
inline

Return the stoichiometric air-fuel mass ratio.

Definition at line 34 of file singleStepReactingMixtureI.H.

◆ s()

const Foam::dimensionedScalar s
inline

Return the Stoichiometric oxygen-fuel mass ratio.

Definition at line 42 of file singleStepReactingMixtureI.H.

◆ qFuel()

const Foam::dimensionedScalar qFuel
inline

Return the heat of combustion [J/Kg].

Definition at line 50 of file singleStepReactingMixtureI.H.

◆ specieStoichCoeffs()

const Foam::List< Foam::scalar > & specieStoichCoeffs
inline

Return the stoichiometric coefficient for the reaction.

Definition at line 58 of file singleStepReactingMixtureI.H.

◆ fres()

Foam::tmp< Foam::volScalarField > fres ( const label  index) const
inline

Return the list of components residual.

Definition at line 66 of file singleStepReactingMixtureI.H.

◆ inertIndex()

Foam::label inertIndex
inline

Return the inert specie index.

Definition at line 77 of file singleStepReactingMixtureI.H.

◆ fuelIndex()

Foam::label fuelIndex
inline

Return the fuel specie index.

Definition at line 85 of file singleStepReactingMixtureI.H.

◆ specieProd()

const Foam::List< int > & specieProd
inline

Return the list to indicate if specie is produced/consumed.

Definition at line 93 of file singleStepReactingMixtureI.H.

◆ Yprod0()

const Foam::scalarList & Yprod0
inline

Return the list of products mass concentrations.

Definition at line 101 of file singleStepReactingMixtureI.H.

◆ read()

void read ( const dictionary thermoDict)

Read dictionary.

Definition at line 254 of file singleStepReactingMixture.C.

Member Data Documentation

◆ stoicRatio_

dimensionedScalar stoicRatio_
protected

Stoichiometric air-fuel mass ratio.

Definition at line 65 of file singleStepReactingMixture.H.

◆ s_

dimensionedScalar s_
protected

Stoichiometric oxygen-fuel mass ratio.

Definition at line 68 of file singleStepReactingMixture.H.

◆ qFuel_

dimensionedScalar qFuel_
protected

Heat of combustion [J/Kg].

Definition at line 71 of file singleStepReactingMixture.H.

◆ specieStoichCoeffs_

scalarList specieStoichCoeffs_
protected

Stoichiometric coefficient for the reaction.

Definition at line 74 of file singleStepReactingMixture.H.

◆ Yprod0_

scalarList Yprod0_
protected

Mass concentrations at stoichiometric mixture for fres.

Definition at line 77 of file singleStepReactingMixture.H.

◆ fres_

PtrList<volScalarField> fres_
protected

List of components residual.

Definition at line 80 of file singleStepReactingMixture.H.

Referenced by singleStepReactingMixture< ThermoType >::singleStepReactingMixture().

◆ inertIndex_

label inertIndex_
protected

Inert specie index.

Definition at line 83 of file singleStepReactingMixture.H.

◆ fuelIndex_

label fuelIndex_
protected

Fuel specie index.

Definition at line 86 of file singleStepReactingMixture.H.

◆ specieProd_

List<int> specieProd_
protected

List to indicate if specie is produced/consumed.

Definition at line 89 of file singleStepReactingMixture.H.


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