ReactionList< ThermoType > Class Template Reference

List of templated reactions. More...

Inheritance diagram for ReactionList< ThermoType >:
Collaboration diagram for ReactionList< ThermoType >:

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
 Default construct. More...
 
 LPtrList (T *item)
 Construct and add initial item pointer. 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. Calls clear() More...
 
Tfront ()
 The first entry in the list. More...
 
const Tfront () const
 The first entry in the list (const access) More...
 
Tback ()
 The last entry in the list. More...
 
const Tback () const
 The last entry in the list (const access) More...
 
template<class... Args>
Templace_front (Args &&... args)
 Emplace construct new element at front of list. Return reference. More...
 
template<class... Args>
Templace_back (Args &&... args)
 Emplace construct new element at back of list. Return reference. More...
 
void pop_front (label n=1)
 Remove first element(s) from the list (deletes pointers) More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (LPtrList< LListBase, T > &lst)
 Transfer the contents of the argument into this List and annul the argument list. More...
 
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...
 
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...
 
- Public Member Functions inherited from LList< LListBase, T *>
 LList ()=default
 Default construct. More...
 
 LList (const T * &elem)
 Construct and copy add initial item. More...
 
 LList (T * &&elem)
 Construct and move add initial item. More...
 
 LList (Istream &is)
 Construct from Istream. More...
 
 LList (const LList< LListBase, T * > &lst)
 Copy construct. More...
 
 LList (LList< LListBase, T * > &&lst)
 Move construct. More...
 
 LList (std::initializer_list< T * > lst)
 Copy construct from an initializer list. More...
 
 ~LList ()
 Destructor. Calls clear() More...
 
reference front ()
 The first entry in the list. More...
 
const_reference front () const
 The first entry in the list (const access) More...
 
reference back ()
 The last entry in the list. More...
 
const_reference back () const
 The last entry in the list (const access) More...
 
void push_front (const T * &elem)
 Add copy at front of list. More...
 
void push_front (T * &&elem)
 Move construct at front of list. More...
 
void push_back (const T * &elem)
 Add copy at back of list. More...
 
void push_back (T * &&elem)
 Move construct at back of list. More...
 
void clear ()
 Delete contents of list. More...
 
void pop_front (label n=1)
 Remove first element(s) from the list (deletes pointers) More...
 
TremoveHead ()
 Remove and return first entry. More...
 
Tremove (link *item)
 Remove and return element. More...
 
Tremove (iterator &iter)
 Remove and return element specified by iterator. More...
 
void transfer (LList< LListBase, T * > &lst)
 Transfer the contents of the argument into this List and annul the argument list. More...
 
void operator= (const LList< LListBase, T * > &lst)
 Copy assignment. More...
 
void operator= (LList< LListBase, T * > &&lst)
 Move assignment. More...
 
void operator= (std::initializer_list< T * > lst)
 Copy assignment from an initializer list. More...
 
IstreamreadList (Istream &is)
 Read list from Istream. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write LList with line-breaks when length exceeds shortLen. More...
 
iterator begin ()
 Iterator to first item in list with non-const access. More...
 
const_iterator begin () const
 Iterator to first item in list with 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 rbegin () const
 Iterator to last item in list with const access. More...
 
const_reverse_iterator crbegin () const
 Iterator to last item in list with const access. More...
 
const iterator & end ()
 End of list for forward iterators. More...
 
const const_iterator & end () const
 End of list for forward iterators. More...
 
const const_iterator & cend () const
 End of list for forward iterators. More...
 
const reverse_iterator & rend ()
 End of list for reverse iterators. More...
 
const const_reverse_iterator & rend () const
 End of list for reverse iterators. More...
 
const const_reverse_iterator & crend () const
 End of list for reverse iterators. More...
 
reference first ()
 The first entry in the list. More...
 
const_reference first () const
 The first entry in the list (const access) More...
 
reference last ()
 The last entry in the list. More...
 
const_reference last () const
 The last entry in the list (const access) More...
 
void prepend (const T * &elem)
 Add copy at front of list. More...
 
void prepend (T * &&elem)
 Move construct at front of list. More...
 
void append (const T * &elem)
 Add copy at back of list. More...
 
void append (T * &&elem)
 Move construct at back of list. More...
 
void insert (const T * &elem)
 Add copy at front of list. Same as push_front() More...
 
void insert (T * &&elem)
 Move construct at front of list. Same as push_front() More...
 

Additional Inherited Members

- Public Types inherited from LPtrList< LListBase, T >
typedef Tpointer
 Pointer for LPtrList::value_type objects. More...
 
typedef const Tconst_pointer
 Const pointer for LPtrList::value_type objects. More...
 
typedef Treference
 Reference for LPtrList::value_type objects. More...
 
typedef const Tconst_reference
 Const 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 Types inherited from LList< LListBase, T *>
typedef Tvalue_type
 Type of values stored. More...
 
typedef T * * pointer
 Pointer for value_type. More...
 
typedef const T * * const_pointer
 Const pointer for value_type. More...
 
typedef T * & reference
 Reference for value_type. More...
 
typedef const T * & const_reference
 Const reference for value_type. More...
 
typedef label size_type
 The type that can represent the container size. More...
 
typedef label difference_type
 The difference between iterators. More...
 
using base_iterator = typename LListBase::iterator
 
using const_base_iterator = typename LListBase::const_iterator
 

Detailed Description

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

List of templated reactions.

Source files

Definition at line 52 of file ReactionList.H.

Constructor & Destructor Documentation

◆ ReactionList() [1/3]

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

Construct empty list.

Definition at line 28 of file ReactionList.C.

◆ ReactionList() [2/3]

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

Construct from dictionary.

Definition at line 42 of file ReactionList.C.

◆ ReactionList() [3/3]

ReactionList ( const ReactionList< ThermoType > &  reactions)

Construct copy.

Definition at line 58 of file ReactionList.C.

◆ ~ReactionList()

~ReactionList ( )
default

Destructor.

Member Function Documentation

◆ readReactionDict()

bool readReactionDict ( )

Read reactions from dictionary.

Definition at line 70 of file ReactionList.C.

◆ write()

void write ( Ostream os) const

Write.

Definition at line 90 of file ReactionList.C.


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