ReactionList< ThermoType > Class Template Reference

List of templated reactions. More...

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

Public Member Functions

 ReactionList (const speciesTable &species, const ReactionTable< ThermoType > &thermoDatabase)
 Construct empty list. More...
 
 ReactionList (const speciesTable &species, const ReactionTable< ThermoType > &thermoDatabase, const dictionary &dict)
 Construct from dictionary. More...
 
 ReactionList (const ReactionList< ThermoType > &reactions)
 Construct copy. More...
 
 ~ReactionList ()=default
 Destructor. More...
 
bool readReactionDict ()
 Read reactions from dictionary. More...
 
void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from LPtrList< LListBase, T >
 LPtrList ()=default
 Null construct. More...
 
 LPtrList (T *item)
 Construct and insert the initial T item. More...
 
 LPtrList (const LPtrList &lst)
 Copy construct by using 'clone()' for each element. More...
 
 LPtrList (LPtrList &&lst)
 Move construct. More...
 
template<class INew >
 LPtrList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 LPtrList (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 ~LPtrList ()
 Destructor. More...
 
Tfirst ()
 The first entry in the list. More...
 
const Tfirst () const
 The first entry in the list (const access) More...
 
Tlast ()
 The last entry in the list. More...
 
const Tlast () const
 The last entry in the list (const access) More...
 
bool eraseHead ()
 Remove the head element from the list and delete the pointer. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (LPtrList< LListBase, T > &lst)
 
void operator= (const LPtrList< LListBase, T > &lst)
 Copy assign by using 'clone()' for each element. More...
 
void operator= (LPtrList< LListBase, T > &&lst)
 Move assign. More...
 
iterator begin ()
 Iterator to first item in list with non-const access. More...
 
const_iterator cbegin () const
 Iterator to first item in list with const access. More...
 
reverse_iterator rbegin ()
 Iterator to last item in list with non-const access. More...
 
const_reverse_iterator crbegin () const
 Iterator to last item in list with const access. More...
 
const_iterator begin () const
 Iterator to first item in list with const access. More...
 
const_reverse_iterator rbegin () const
 Iterator to last item in list with const access. More...
 
const iteratorend ()
 End of list for forward iterators. More...
 
const const_iteratorcend () const
 End of list for forward iterators. More...
 
const reverse_iteratorrend ()
 End of list for reverse iterators. More...
 
const const_reverse_iteratorcrend () const
 End of list for reverse iterators. More...
 
const const_iteratorend () const
 End of list for forward iterators. More...
 
const const_reverse_iteratorrend () const
 End of list for reverse iterators. More...
 

Additional Inherited Members

- Public Types inherited from LPtrList< LListBase, T >
typedef Tpointer
 Pointer for LPtrList::value_type objects. More...
 
typedef Treference
 Reference for LPtrList::value_type objects. More...
 
using base_iterator = typename LListBase::iterator
 
using const_base_iterator = typename LListBase::const_iterator
 
typedef LList< LListBase, T * > parent_type
 The parent list storage. More...
 
- Public Attributes inherited from LPtrList< LListBase, T >
const typedef Tconst_pointer
 Const pointer for LPtrList::value_type objects. More...
 
const typedef Tconst_reference
 Const reference for LPtrList::value_type objects. More...
 

Detailed Description

template<class ThermoType>
class Foam::ReactionList< ThermoType >

List of templated reactions.

Source files

Definition at line 56 of file ReactionList.H.

Constructor & Destructor Documentation

◆ ReactionList() [1/3]

ReactionList ( const speciesTable species,
const ReactionTable< ThermoType > &  thermoDatabase 
)

Construct empty list.

Definition at line 35 of file ReactionList.C.

◆ ReactionList() [2/3]

ReactionList ( const speciesTable species,
const ReactionTable< ThermoType > &  thermoDatabase,
const dictionary dict 
)

Construct from dictionary.

Definition at line 49 of file ReactionList.C.

◆ ReactionList() [3/3]

ReactionList ( const ReactionList< ThermoType > &  reactions)

Construct copy.

Definition at line 65 of file ReactionList.C.

◆ ~ReactionList()

~ReactionList ( )
default

Destructor.

Member Function Documentation

◆ readReactionDict()

bool readReactionDict ( )

Read reactions from dictionary.

Definition at line 77 of file ReactionList.C.

◆ write()

void write ( Ostream os) const

Write.

Definition at line 97 of file ReactionList.C.


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