Reaktoro  v2.0.0
A unified framework for modeling chemically reactive systems
MineralPhases Class Reference

The class used to configure automatic selection of pure mineral phases. More...

#include <Phases.hpp>

Collaboration diagram for MineralPhases:
[legend]

Public Member Functions

 MineralPhases ()
 Construct a default MineralPhases object.
 
 MineralPhases (const StringList &species)
 Construct a MineralPhases object with given species names.
 
 MineralPhases (const Speciate &elements)
 Construct a MineralPhases object with given element symbols.
 
 MineralPhases (const Speciate &elements, const Exclude &withtags)
 Construct a MineralPhases object with given element symbols excluding the species with provided tags.
 
 MineralPhases (const Exclude &withtags)
 Construct a MineralPhases object excluding the species with provided tags.
 
auto initialize () -> void
 Initialize the default attributes of this MineralPhases object.
 
- Public Member Functions inherited from GenericPhasesGenerator
 GenericPhasesGenerator ()
 Construct a default GenericPhasesGenerator object.
 
 GenericPhasesGenerator (const StringList &species)
 Construct a GenericPhasesGenerator object with given species names.
 
 GenericPhasesGenerator (const Speciate &elements)
 Construct a GenericPhasesGenerator object with given element symbols.
 
 GenericPhasesGenerator (const Speciate &elements, const Exclude &withtags)
 Construct a GenericPhasesGenerator object with given element symbols excluding the species with provided tags.
 
 GenericPhasesGenerator (const Exclude &withtags)
 Construct a GenericPhasesGenerator object excluding the species with provided tags.
 
virtual ~GenericPhasesGenerator ()
 Destroy this GenericPhasesGenerator object.
 
auto setStateOfMatter (StateOfMatter option) -> GenericPhasesGenerator &
 Set the common state of matter of the generated phases.
 
auto setAggregateState (AggregateState option) -> GenericPhasesGenerator &
 Set the common aggregate state of the species in the generated phases.
 
auto setAdditionalAggregateStates (const Vec< AggregateState > &options) -> GenericPhasesGenerator &
 Set additional aggregate states to be considered when searching for species in a database.
 
auto setActivityModel (const ActivityModelGenerator &model) -> GenericPhasesGenerator &
 Set the common activity model of the generated phases.
 
auto setIdealActivityModel (const ActivityModelGenerator &model) -> GenericPhasesGenerator &
 Set the common ideal activity model of the generated phases.
 
auto set (StateOfMatter option) -> GenericPhasesGenerator &
 Set the common state of matter of the generated phases (equivalent to GenericPhasesGenerator::setStateOfMatter).
 
auto set (AggregateState option) -> GenericPhasesGenerator &
 Set the common aggregate state of the species in the generated phases (equivalent to GenericPhasesGenerator::setAggregateState).
 
auto set (const ActivityModelGenerator &model) -> GenericPhasesGenerator &
 Set the common activity model of the generated phases (equivalent to GenericPhasesGenerator::setActivityModel).
 
auto stateOfMatter () const -> StateOfMatter
 Return the common state of matter of the generated phases.
 
auto aggregateState () const -> AggregateState
 Return the common aggregate state of the species composing the generated phases.
 
auto additionalAggregateStates () const -> const Vec< AggregateState > &
 Return the additional aggregate states to be considered when searching for species in a database.
 
auto species () const -> const Strings &
 Return the names of the selected species to compose the generated phase (empty if not given).
 
auto elements () const -> const Strings &
 Return the element symbols for automatic species selection that will compose the generated phases (empty if not given).
 
auto activityModel () const -> const ActivityModelGenerator &
 Return the specified common activity model of the generated phases.
 
auto idealActivityModel () const -> const ActivityModelGenerator &
 Return the specified common ideal activity model of the generated phases.
 
auto convert (const Database &db, const Strings &elements) const -> Vec< GenericPhase >
 Convert this GenericPhasesGenerator object into a vector of GenericPhase objects.
 

Detailed Description

The class used to configure automatic selection of pure mineral phases.


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