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

Used to define mineral surfaces that react with aqueous phases. More...

#include <MineralSurface.hpp>

Collaboration diagram for MineralSurface:
[legend]

Public Member Functions

 MineralSurface (String const &mineral)
 Construct a MineralSurface object. More...
 
 MineralSurface (String const &mineral, real A, Chars unitA)
 Construct a MineralSurface object with a constant or linear surface area model. More...
 
 MineralSurface (String const &mineral, real A0, Chars unitA0, real q0, Chars unitq0, real p)
 Construct a MineralSurface object with a power surface area model. More...
 
- Public Member Functions inherited from GeneralSurface
 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 mineral surfaces that react with aqueous phases.

Constructor & Destructor Documentation

◆ MineralSurface() [1/3]

MineralSurface ( String const &  mineral)
explicit

Construct a MineralSurface object.

Parameters
mineralThe name of the mineral phase in the chemical system.

◆ MineralSurface() [2/3]

MineralSurface ( String const &  mineral,
real  A,
Chars  unitA 
)

Construct a MineralSurface object with a constant or linear surface area model.

If unitA is convertible to m2, then a constant surface area model is assigned to the mineral surface (

See also
SurfaceAreaModelConstant). If unitA is convertible to m2/mol, m2/kg, or m2/m3, then a linear surface area model is assigned instead (
SurfaceAreaModelLinear). Otherwise, an error occurs due to non-conforming unit value for unitA.
Parameters
mineralThe name of the mineral phase in the chemical system.
AThe actual or normalized surface area value of the mineral phase.
unitAThe unit of A (must be convertible to m2, m2/mol, m2/kg, or m2/m3).

◆ MineralSurface() [3/3]

MineralSurface ( String const &  mineral,
real  A0,
Chars  unitA0,
real  q0,
Chars  unitq0,
real  p 
)

Construct a MineralSurface object with a power surface area model.

For more details about the power law used for the surface area model, see SurfaceAreaModelPower.

Parameters
mineralThe name of the mineral phase in the chemical system.
A0The initial surface area of the mineral phase.
unitA0The unit of A0 (must be convertible to m2).
q0The initial quantity of the mineral phase.
unitq0The unit of q0 (must be convertible to mol, kg, or m3).
pThe power parameter in the model.

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