Foam::reactingMixture. More...
Public Types | |
typedef ThermoType | thermoType |
The type of thermo package this mixture is instantiated for. More... | |
Public Types inherited from List< T > | |
typedef SubList< T > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< T > | |
typedef T | value_type |
The value type the list contains. More... | |
typedef T * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const T * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef T & | reference |
The type used for storing into value_type objects. More... | |
typedef const T & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef T * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const T * | const_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< iterator > | reverse_iterator |
Reverse iterator (non-const access) More... | |
typedef std::reverse_iterator< const_iterator > | const_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 T & | reference |
A non-const reference to the value_type. More... | |
typedef const T & | const_reference |
A const reference to the value_type. More... | |
Public Member Functions | |
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< speciesCompositionTable > | specieComposition () 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... | |
label | push_uniq (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) |
Transfer contents of the argument into this list and annul the argument list, optionally eliminating duplicates. More... | |
void | transfer (wordList &list, bool unique=false) |
Transfer the contents of the argument List into this list and annul the argument list, optionally eliminating duplicates. More... | |
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 () |
Adjust the list (if needed) to eliminate duplicate entries, and rehash the indices. More... | |
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 | contains (const word &val) const |
Is the value contained in the list (searches the hash). More... | |
const word & | operator[] (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 contains(). 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 | found (const word &val) const |
Same as contains(), searches the hash. More... | |
void | append (const word &val) |
Same as push_uniq() More... | |
void | push_back (const word &val) |
Same as push_uniq() More... | |
label | appendUniq (const word &val) |
Same as push_uniq() More... | |
Public Member Functions inherited from List< T > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const T &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 T &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, T &&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< T > &list) | |
Copy construct from list. More... | |
List (const UList< T > &list) | |
Copy construct contents from list. More... | |
List (List< T > &list, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< T > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
template<unsigned N> | |
List (const UList< T > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
template<unsigned N> | |
List (const FixedList< T, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< T > &list) | |
Construct as copy of PtrList<T> More... | |
template<class Addr > | |
List (const IndirectListBase< T, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< T > list) | |
Construct from an initializer list. More... | |
List (List< T > &&list) noexcept | |
Move construct from List. More... | |
template<int SizeMin> | |
List (DynamicList< T, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
autoPtr< List< T > > | 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 T &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize_fill (const label len, const T &val) |
Adjust allocated size of list and set val for all elements. More... | |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | resize_unsafe (const label len) noexcept |
Change the addressed list size directly without affecting any memory management (advanced usage). More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const T &val) |
Alias for resize() More... | |
void | transfer (List< T > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
template<int SizeMin> | |
void | transfer (DynamicList< T, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
T & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
template<class... Args> | |
T & | emplace_back (Args &&... args) |
Construct an element at the end of the list, return reference to the new list element. More... | |
void | push_back (const T &val) |
Append an element at the end of the list. More... | |
void | push_back (T &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< T > &list) |
Append a List to the end of this list. More... | |
template<class Addr > | |
void | push_back (const IndirectListBase< T, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const T &val) |
Append an element if not already in the list. More... | |
void | pop_back (label n=1) |
Reduce size by 1 or more elements. Can be called on an empty list. More... | |
void | operator= (const UList< T > &list) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< T > &list) |
Assignment operator. Takes linear time. More... | |
template<class Addr > | |
void | operator= (const IndirectListBase< T, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
template<unsigned N> | |
void | operator= (const FixedList< T, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< T > list) |
Assignment to an initializer list. 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... | |
void | operator= (List< T > &&list) |
Move assignment. Takes constant time. More... | |
template<int SizeMin> | |
void | operator= (DynamicList< T, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
void | shallowCopy (const UList< T > &)=delete |
No shallowCopy permitted. More... | |
template<class TypeT = T> | |
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... | |
void | append (const T &val) |
Append an element at the end of the list. More... | |
void | append (T &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< T > &list) |
Append a List to the end of this list. More... | |
template<class Addr > | |
void | append (const IndirectListBase< T, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const T &val) |
Same as push_uniq() More... | |
List (const SLList< T > &list) | |
Copy construct from SLList. More... | |
void | operator= (const SLList< T > &list) |
Copy assign from SLList in linear time. More... | |
template<> | |
void | resize (const label newLen) |
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 |
The forward circular index. The next index in the list which returns to the first at the end of the list. More... | |
label | rcIndex (const label i) const noexcept |
The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More... | |
const T & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
T & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const T & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
T & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const T * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
T * | data () 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... | |
T & | front () |
Access first element of the list, position [0]. More... | |
const T & | front () const |
Access first element of the list. More... | |
T & | back () |
Access last element of the list, position [size()-1]. More... | |
const T & | back () const |
Access last element of the list, position [size()-1]. More... | |
std::streamsize | size_bytes () const noexcept |
Number of contiguous bytes for the List data. More... | |
std::streamsize | byteSize () const |
Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
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... | |
bool | contains (const T &val) const |
True if the value is contained in the list. More... | |
bool | contains (const T &val, label pos, label len=-1) const |
Is the value contained in the list? More... | |
label | find (const T &val) const |
Find index of the first occurrence of the value. More... | |
label | find (const T &val, label pos, label len=-1) 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... | |
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 (T *__restrict__ ptr, const label len) noexcept |
Copy the pointer and size. More... | |
void | shallowCopy (std::nullptr_t) noexcept |
Copy nullptr and zero size. More... | |
void | shallowCopy (const UList< T > &list) noexcept |
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< T > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< T > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< T > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< T > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
T & | operator[] (const label i) |
Return element of UList. More... | |
const T & | operator[] (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... | |
iterator | begin (const label i) noexcept |
Return iterator at offset i from begin, clamped to [0,size] range. 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... | |
const_iterator | cbegin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | begin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. 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... | |
bool | empty () const noexcept |
True if List is empty (ie, size() is zero) More... | |
label | size () const noexcept |
The number of elements in the container. More... | |
label | capacity () const noexcept |
Size of the underlying storage. More... | |
void | swap (UList< T > &list) noexcept |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< T > &list) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< T > &list) 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 > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< T > &list) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< T > &list) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (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... | |
Ostream & | writeList (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 |
Test bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
T & | first () |
Access first element of the list, position [0]. More... | |
const T & | first () const |
Access first element of the list. More... | |
T & | last () |
Access last element of the list, position [size()-1]. More... | |
const T & | last () const |
Access last element of the list, position [size()-1]. More... | |
bool | found (const T &val, label pos=0) const |
Same as contains() More... | |
template<> | |
const bool & | operator[] (const label i) const |
template<> | |
UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const UPstream::commsStruct & | operator[] (const label procID) const |
template<> | |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
Public Member Functions inherited from multiComponentMixture< ThermoType > | |
multiComponentMixture (const dictionary &, const wordList &specieNames, const ReactionTable< ThermoType > &thermoData, const fvMesh &mesh, const word &phaseName) | |
Construct from dictionary, specie names, thermo database, mesh and phase name. More... | |
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... | |
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 speciesTable & | species () 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... | |
volScalarField & | Y (const label i) |
Return the mass-fraction field for a specie given by index. More... | |
const volScalarField & | Y (const label i) const |
Return the const mass-fraction field for a specie given by index. More... | |
volScalarField & | Y (const word &specieName) |
Return the mass-fraction field for a specie given by name. More... | |
const volScalarField & | Y (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) noexcept | |
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. Frees all pointers. 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 |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
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, std::unique_ptr< Reaction< ThermoType > > &&ptr) |
Set element to given unique_ptr 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, 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... | |
autoPtr< Reaction< ThermoType > > | set (const label i, autoPtr< Reaction< ThermoType > > &ptr) |
Set element to given autoPtr and return old element. More... | |
void | clear () |
Clear the PtrList. Delete allocated entries and set size to zero. More... | |
void | free () |
Free memory and nullify all entries. Does not change the list size. More... | |
void | resize (const label newLen) |
Adjust size of PtrList. More... | |
void | resize_null (const label newLen) |
Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all nullptr entries. More... | |
Reaction< ThermoType > & | emplace_back (Args &&... args) |
Construct and append an element to the end of the list, return reference to the new list element. More... | |
void | push_back (Reaction< ThermoType > *ptr) |
Append an element to the end of the list. More... | |
void | push_back (std::unique_ptr< Reaction< ThermoType > > &&ptr) |
Move append an element to the end of the list. More... | |
void | push_back (autoPtr< Reaction< ThermoType > > &&ptr) |
Move append an element to the end of the list. More... | |
void | push_back (const refPtr< Reaction< ThermoType > > &ptr) |
Move or clone append a refPtr to the end of the list. More... | |
void | push_back (const tmp< Reaction< ThermoType > > &ptr) |
Move or clone append a tmp to the end of the list. More... | |
void | push_back (PtrList< Reaction< ThermoType > > &&other) |
Move append another list to the end of this list. More... | |
void | push_back (autoPtr< Reaction< ThermoType > > &ptr)=delete |
Disallow push_back with autoPtr without std::move. More... | |
Reaction< ThermoType > & | emplace_set (const label i, Args &&... args) |
Construct and set a new element at given position, (discard old element at that location). More... | |
Reaction< ThermoType > & | emplace (const label i, Args &&... args) |
Same as emplace_set() More... | |
Reaction< ThermoType > & | try_emplace (const label i, Args &&... args) |
Like emplace_set() but will not overwrite an occupied (non-null) location. More... | |
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... | |
void | setSize (const label newLen) |
Same as resize() More... | |
void | append (autoPtr< Reaction< ThermoType > > &ptr) |
Move 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 (std::unique_ptr< 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 (const refPtr< Reaction< ThermoType > > &ptr) |
Move or clone append a tmp 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... | |
Public Member Functions inherited from UPtrList< T > | |
constexpr | UPtrList () noexcept=default |
Default construct. More... | |
UPtrList (const label len) | |
Construct with specified size and set all entries to nullptr . More... | |
UPtrList (const UPtrList< T > &list) | |
Copy construct (shallow copies addresses) More... | |
UPtrList (UPtrList< T > &&list) noexcept | |
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... | |
bool | empty () const noexcept |
True if the list is empty (ie, size() is zero) More... | |
label | size () const noexcept |
The number of entries in the list. More... | |
label | capacity () const noexcept |
Size of the underlying storage. More... | |
label | count_nonnull () const noexcept |
The number of non-nullptr entries in the list. More... | |
T & | front () |
Reference to the first element of the list. More... | |
const T & | front () const |
Reference to first element of the list. More... | |
T & | back () |
Reference to the last element of the list. More... | |
const T & | back () const |
Reference to the last element of the list. More... | |
const T * | test (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
const T * | get (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
T * | get (const label i) |
Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
const T * | set (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
void | clear () |
Set list size to zero. More... | |
void | free () |
Nullify all entries. Does not change the list size. More... | |
void | resize (const label newLen) |
Change the size of the list. Any new entries are nullptr . More... | |
void | resize_null (const label newLen) |
Set the list to the given size and set all entries to nullptr . More... | |
label | squeezeNull () |
Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. More... | |
void | trimTrailingNull () |
Reduce addressable list size to ignore any trailing null pointers. More... | |
void | push_back (T *ptr) |
Append an element to the end of the list. More... | |
void | push_back (UPtrList< T > &&other) |
Move append another list to the end of this list. More... | |
void | swap (UPtrList< T > &list) noexcept |
Swap content. More... | |
void | transfer (UPtrList< T > &list) |
Transfer contents into this list and annul the argument. More... | |
T * | set (const label i, T *ptr) |
Set element to specified pointer and return the old list element, which can be a nullptr. More... | |
void | reorder (const labelUList &oldToNew, const bool check=false) |
Reorder elements. Reordering must be unique (ie, shuffle). More... | |
void | sortOrder (const labelUList &order, const bool check=false) |
Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More... | |
void | checkNonNull () const |
Check and raise FatalError if any nullptr exists in the list. More... | |
const T & | at (const label i) const |
Return const reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
T & | at (const label i) |
Return reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
const T & | operator[] (const label i) const |
Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
T & | operator[] (const label i) |
Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const | |
Deprecated(2022-09) - 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 () |
Return iterator to begin traversal of non-nullptr entries. More... | |
iterator | end () noexcept |
Return iterator beyond end of UPtrList traversal. More... | |
const_iterator | cbegin () const |
Return const_iterator to begin traversal of non-nullptr entries. More... | |
const_iterator | cend () const noexcept |
Return const_iterator beyond end of UPtrList traversal. More... | |
const_iterator | begin () const |
Return const_iterator to begin traversal of non-nullptr entries. More... | |
const_iterator | end () const noexcept |
Return const_iterator beyond end of UPtrList traversal. More... | |
void | setSize (const label n) |
Alias for resize() More... | |
T & | first () |
Reference to the first element of the list. More... | |
const T & | first () const |
Return reference to first element of the list. More... | |
T & | last () |
Return reference to the last element of the list. More... | |
const T & | last () const |
Return reference to the last element of the list. 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... | |
label | count () const noexcept |
The number of non-nullptr entries in the list. More... | |
Static Public Member Functions | |
static word | typeName () |
Return the instantiated type name. More... | |
Static Public Member Functions inherited from List< T > | |
static const List< T > & | null () noexcept |
Return a null List (reference to a nullObject). Behaves like an empty List. More... | |
Static Public Member Functions inherited from UList< T > | |
static const UList< T > & | null () noexcept |
Return a null UList (reference to a nullObject). Behaves like an empty UList. 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... | |
Additional Inherited Members | |
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 |
Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More... | |
void | fill_uniform (const T &val) |
Assign all entries to the given value. More... | |
void | fill_uniform (const Foam::zero) |
Assign all entries to zero. More... | |
UList< T > & | operator= (const UList< T > &)=delete |
No copy assignment (default: shallow copy) More... | |
template<> | |
void | writeEntry (Ostream &os) const |
Character list writeEntry. More... | |
template<> | |
void | operator= (const Foam::zero) |
Character list assign zero - avoids Foam::zero casting ambiguities. More... | |
template<> | |
void | writeEntry (Ostream &os) const |
template<> | |
void | operator= (const Foam::zero) |
Protected Member Functions inherited from PtrList< Reaction< ThermoType > > | |
void | readIstream (Istream &is, const INew &inew) |
Read from Istream using Istream constructor class. More... | |
Protected Member Functions inherited from UPtrList< T > | |
void | setAddressableSize (const label n) noexcept |
Adjust addressable size. More... | |
label | find_next (label pos) const |
The next non-null entry after the specified position. More... | |
UPtrList (Detail::PtrListDetail< T > &&ptrs) noexcept | |
Low-level move construct. More... | |
Protected Attributes inherited from basicMultiComponentMixture | |
speciesTable | species_ |
Table of specie names. More... | |
List< bool > | active_ |
List of specie active flags. More... | |
PtrList< volScalarField > | Y_ |
Species mass fractions. More... | |
Protected Attributes inherited from UPtrList< T > | |
Detail::PtrListDetail< T > | ptrs_ |
The list of pointers. More... | |
Definition at line 53 of file reactingMixture.H.
typedef ThermoType thermoType |
The type of thermo package this mixture is instantiated for.
Definition at line 91 of file reactingMixture.H.
reactingMixture | ( | const dictionary & | thermoDict, |
const fvMesh & | mesh, | ||
const word & | phaseName | ||
) |
Construct from dictionary, mesh and phase name.
Definition at line 38 of file reactingMixture.C.
|
virtualdefault |
Destructor.
|
inlinestatic |
Return the instantiated type name.
Definition at line 118 of file reactingMixture.H.
void read | ( | const dictionary & | thermoDict | ) |
Read dictionary.
Definition at line 74 of file reactingMixture.C.
|
inlinevirtual |
Table of species composition.
Reimplemented from basicSpecieMixture.
Definition at line 134 of file reactingMixture.H.