A single rate expression for the kinetic species with index kinetic_species_index. More...

#include <PertinentGeochemicalSystem.h>

Public Member Functions
	KineticRateDefinition (unsigned kinetic_species_index, const std::vector< Real > &promoting_indices, const std::vector< Real > &promoting_monod_indices, const std::vector< Real > &promoting_half_saturation, unsigned progeny_index, const KineticRateUserDescription &description)

bool	operator== (const KineticRateDefinition &rhs) const

Public Attributes
unsigned	kinetic_species_index

std::vector< Real >	promoting_indices

std::vector< Real >	promoting_monod_indices

std::vector< Real >	promoting_half_saturation

unsigned	progeny_index

KineticRateUserDescription	description

Detailed Description

A single rate expression for the kinetic species with index kinetic_species_index.

Parameters

kinetic_species_index	index of the kinetic species that is governed by this rate
promoting_indices	the kinetic rate is multiplied by the produce over all basis and equilibrium species of m^promoting_indices / (m^promoting_indices + promoting_half_saturation^promoting_indices)^promoting_monod_indices, where m is the molality or activity of the species
promoting_monod_indices	the kinetic rate is multiplied by the produce over all basis and equilibrium species of m^promoting_indices / (m^promoting_indices + promoting_half_saturation^promoting_indices)^promoting_monod_indices, where m is the molality or activity of the species
promoting_half_saturation	the kinetic rate is multiplied by the produce over all basis and equilibrium species of m^promoting_indices / (m^promoting_indices + promoting_half_saturation^promoting_indices)^promoting_monod_indices, where m is the molality or activity of the species
progeny_index	the index of the basis or equilibrium species in the current basis that is produced by the kinetic reaction (usually this is 0, and description.progeny_efficiency = 0, so there are no progeny effects)
description	the KineticRateUserDescription of this rate

Definition at line 58 of file PertinentGeochemicalSystem.h.

Constructor & Destructor Documentation

◆ KineticRateDefinition()

KineticRateDefinition::KineticRateDefinition	(	unsigned	kinetic_species_index,
		const std::vector< Real > &	promoting_indices,
		const std::vector< Real > &	promoting_monod_indices,
		const std::vector< Real > &	promoting_half_saturation,
		unsigned	progeny_index,
		const KineticRateUserDescription &	description
	)

inline

Definition at line 60 of file PertinentGeochemicalSystem.h.

     : kinetic_species_index(kinetic_species_index),
       promoting_indices(promoting_indices),
       promoting_monod_indices(promoting_monod_indices),
       promoting_half_saturation(promoting_half_saturation),
       progeny_index(progeny_index),
       description(description){};

Member Function Documentation

◆ operator==()

bool KineticRateDefinition::operator== ( const KineticRateDefinition & rhs ) const

inline

Definition at line 73 of file PertinentGeochemicalSystem.h.

   {
     return (kinetic_species_index == rhs.kinetic_species_index) &&
            (promoting_indices == rhs.promoting_indices) &&
            (promoting_monod_indices == rhs.promoting_monod_indices) &&
            (promoting_half_saturation == rhs.promoting_half_saturation) &&
            (progeny_index == rhs.progeny_index) && (description == rhs.description);
   };