The class used to configure mineral dissolution/precipitation reactions. More...

#include <MineralReaction.hpp>

Collaboration diagram for MineralReaction:

Public Member Functions
	MineralReaction (String const &mineral)
	Construct a MineralReaction object with given mineral name. More...

auto	setRateModel (MineralReactionRateModel const &model) -> MineralReaction &
	Set the mineral reaction rate model of the reaction as a rate function.

auto	setRateFunction (MineralReactionRateModel const &model) -> MineralReaction &
	Set the mineral reaction rate model of the reaction as a rate function.

auto	setRateModel (MineralReactionRateModelGenerator const &model_generator) -> MineralReaction &
	Set the mineral reaction rate model of the reaction as a model generator function. More...

auto	mineral () const -> String const &
	Return the name of the mineral.

auto	setRateModel (ReactionRateModel const &model) -> GeneralReaction &
	Set the reaction rate model of the reaction.

auto	setRateModel (ReactionRateModelGenerator const &model_generator) -> GeneralReaction &
	Set the reaction rate model generator of the reaction. More...

Public Member Functions inherited from GeneralReaction
	GeneralReaction ()
	Construct a default GeneralReaction object.

	GeneralReaction (String const &equation)
	Construct a GeneralReaction object with given reaction equation as a formatted string. More...

auto	setName (String const &name) -> GeneralReaction &
	Set the unique name of the reaction.

auto	setEquation (String const &equation) -> GeneralReaction &
	Set the equation of the reaction as a formatted string. More...

auto	setRateModel (ReactionRateModel const &model) -> GeneralReaction &
	Set the reaction rate model of the reaction.

auto	setRateModel (ReactionRateModelGenerator const &model_generator) -> GeneralReaction &
	Set the reaction rate model generator of the reaction. More...

auto	set (ReactionRateModelGenerator const &model_generator) -> GeneralReaction &
	Set the reaction rate model generator of the reaction (equivalent to GeneralReaction::setRateModel).

auto	name () const -> String const &
	Return the name of the reaction.

auto	equation () const -> String const &
	Return the reaction equation of the reaction.

auto	rateModel () const -> ReactionRateModel const &
	Return the reaction rate model of the reaction.

auto	rateModelGenerator () const -> ReactionRateModelGenerator const &
	Return the reaction rate model generator of the reaction.

auto	operator() (ReactionGeneratorArgs args) const -> Reaction
	Convert this GeneralReaction object into a Reaction object.

Detailed Description

The class used to configure mineral dissolution/precipitation reactions.

Constructor & Destructor Documentation

◆ MineralReaction()

MineralReaction ( String const & mineral )

explicit

Construct a MineralReaction object with given mineral name.

Parameters

mineral The name of the mineral as found in the database.

Member Function Documentation

◆ setRateModel() [1/2]

auto setRateModel ( MineralReactionRateModelGenerator const & model_generator ) -> MineralReaction &

Set the mineral reaction rate model of the reaction as a model generator function.

Use this method to set a MineralReactionRateModelGenerator in case you need the MineralReactionRateModel of the reaction to be constructed later, when the chemical system is assembled.

◆ setRateModel() [2/2]

auto setRateModel

Set the reaction rate model generator of the reaction.

Use this method to set a ReactionRateModelGenerator in case you need the ReactionRateModel of the reaction to be constructed later, when the chemical system is assembled.

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