Reaktoro  v2.1.1
A unified framework for modeling chemically reactive systems
SurfaceList Class Reference

A type used as a collection of surfaces. More...

#include <SurfaceList.hpp>

Public Types

using value_type = Surface
 The type of the value stored in a SurfaceList (for STL compatibility reasons).
 

Public Member Functions

 SurfaceList ()
 Construct a default SurfaceList object.
 
 SurfaceList (std::initializer_list< Surface > surfaces)
 Construct an SurfaceList object with given surfaces.
 
 SurfaceList (Vec< Surface > const &surfaces)
 Construct an SurfaceList object with given surfaces.
 
auto append (Surface const &surface) -> void
 Append a new surface to the list of surfaces.
 
auto data () const -> Vec< Surface > const &
 Return the internal collection of Surface objects.
 
auto empty () const -> bool
 Return true if there are no surfaces in the collection.
 
auto size () const -> Index
 Return the number of surfaces in the collection.
 
auto operator[] (Index i) const -> Surface const &
 Return the Surface object with given index.
 
auto operator[] (Index i) -> Surface &
 Return the Surface object with given index.
 
auto find (String const &name) const -> Index
 Return the index of the first surface with given name or the number of surfaces if not found.
 
auto findWithName (String const &name) const -> Index
 Return the index of the first surface with given unique name or the number of surfaces if not found.
 
auto index (String const &name) const -> Index
 Return the index of the first surface with given name or throw a runtime error if not found.
 
auto indexWithName (String const &name) const -> Index
 Return the index of the first surface with given unique name or throw a runtime error if not found.
 
auto get (String const &name) const -> Surface const &
 Return the surface with given name.
 
auto getWithName (String const &name) const -> Surface const &
 Return the surface with given name or throw a runtime error if not found.
 
auto withNames (StringList const &names) const -> SurfaceList
 Return all surfaces with given names.
 
 operator Vec< Surface > & ()
 Convert this SurfaceList object into its Vec<Surface>.
 
 operator Vec< Surface >const & () const
 Convert this SurfaceList object into its Vec<Surface>.
 
template<typename InputIterator >
 SurfaceList (InputIterator begin, InputIterator end)
 Construct an SurfaceList object with given begin and end iterators.
 
auto begin () const
 Return begin const iterator of this SurfaceList instance (for STL compatibility reasons).
 
auto begin ()
 Return begin iterator of this SurfaceList instance (for STL compatibility reasons).
 
auto end () const
 Return end const iterator of this SurfaceList instance (for STL compatibility reasons).
 
auto end ()
 Return end iterator of this SurfaceList instance (for STL compatibility reasons).
 
auto push_back (Surface const &surfaces) -> void
 Append a new Surface at the back of the container (for STL compatibility reasons).
 
template<typename Iterator , typename InputIterator >
auto insert (Iterator pos, InputIterator begin, InputIterator end) -> void
 Insert a container of Surface objects into this SurfaceList instance (for STL compatibility reasons).
 

Detailed Description

A type used as a collection of surfaces.


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