chemmisol::FixedChemicalComponent Class Reference

#include <species.h>

Inheritance diagram for chemmisol::FixedChemicalComponent:

Collaboration diagram for chemmisol::FixedChemicalComponent:

Public Member Functions
	FixedChemicalComponent (FixedChemicalSpecies *species, std::size_t index)
virtual bool	isFixed () const override
Public Member Functions inherited from chemmisol::ChemicalComponent
	ChemicalComponent (ChemicalSpecies *species, std::size_t index, double total_quantity)
ChemicalSpecies *	getSpecies ()
const ChemicalSpecies *	getSpecies () const
std::size_t	getIndex () const
double	getTotalQuantity () const
void	setTotalQuantity (double quantity)
void	setTotalConcentration (double concentration)

Detailed Description

ChemicalComponent implementation for a fixed component.

Notice that calling setTotalQuantity() on a FixedChemicalComponent is valid.

• When setTotalQuantity() is called on a regular component, the total quantity is dispatched among produced species when the equilibrium solver is run.
• When setTotalQuantity() is called on a fixed component, the quantity of the associated species is fixed to the provided value.

However, fixing the quantity of the associated species is not handled by the FixedChemicalComponent itself, but by the ChemicalSystem::fixComponent() method.

See also

ChemicalSystem::fixComponent()

Constructor & Destructor Documentation

FixedChemicalComponent()

chemmisol::FixedChemicalComponent::FixedChemicalComponent ( FixedChemicalSpecies *  species, std::size_t  index  )

inline

Defines a FixedChemicalComponent.

The total quantity of the fixed component is initialized from the quantity of the associated fixed species.

Parameters

species	The fixed chemical species instance associated to this component.
index	Index used to retrieve the component in data structures used internally by the ChemicalSystem. The index can also be used to uniquely identify each component of a system.

Member Function Documentation

isFixed()

virtual bool chemmisol::FixedChemicalComponent::isFixed ( ) const

inlineoverridevirtual

Returns true if this component is fixed. Returns false by default, but can be overridden by subclasses.

Reimplemented from chemmisol::ChemicalComponent.

---

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

• include/chemmisol/chemical/species.h