Reaktoro  v2.11.0
A unified framework for modeling chemically reactive systems
GeneralSurface Class Reference

Used to define a general surface. More...

#include <Surfaces.hpp>

Public Member Functions

 GeneralSurface ()
 Construct a default GeneralSurface object.
 
 GeneralSurface (String const &name)
 Construct a GeneralSurface object with given unique surface name.
 
 GeneralSurface (String const &name, SurfaceAreaModel const &area_model)
 Construct a GeneralSurface object with given unique surface name and area model.
 
auto setName (String const &name) -> GeneralSurface &
 Set the unique name of the surface.
 
auto setAreaModel (SurfaceAreaModel const &model) -> GeneralSurface &
 Set the area model of the surface.
 
auto set (SurfaceAreaModel const &model) -> GeneralSurface &
 Set the area model of the surface (equivalent to GeneralSurface::setAreaModel).
 
auto name () const -> String const &
 Return the name of the surface.
 
auto areaModel () const -> SurfaceAreaModel const &
 Return the area model of the surface.
 
auto operator() (PhaseList const &phases) const -> Surface
 Convert this GeneralSurface object into a Surface object.
 

Detailed Description

Used to define a general surface.


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