Interface Documentation
ChemicalEngineDicts
ChemicalEngineDicts.Eh
ChemicalEngineDicts.IS
ChemicalEngineDicts.P
ChemicalEngineDicts.T
ChemicalEngineDicts.activate_multiple_phases()
ChemicalEngineDicts.activate_multiple_species()
ChemicalEngineDicts.activate_phase()
ChemicalEngineDicts.activate_species()
ChemicalEngineDicts.add_amt_from_formula()
ChemicalEngineDicts.add_element_amt()
ChemicalEngineDicts.add_multiple_elements_amt()
ChemicalEngineDicts.add_multiple_species_amt()
ChemicalEngineDicts.add_species_amt()
ChemicalEngineDicts.aq_composition
ChemicalEngineDicts.aq_el_M
ChemicalEngineDicts.aq_el_my
ChemicalEngineDicts.aq_elements_amounts
ChemicalEngineDicts.aq_elements_molality
ChemicalEngineDicts.aq_elements_molarity
ChemicalEngineDicts.aq_elements_moles
ChemicalEngineDicts.aq_phase_symbol
ChemicalEngineDicts.aq_sp_M
ChemicalEngineDicts.aq_sp_my
ChemicalEngineDicts.aq_species_composition
ChemicalEngineDicts.aq_species_molality
ChemicalEngineDicts.aq_species_molarity
ChemicalEngineDicts.aq_volume_frac
ChemicalEngineDicts.bulk_composition
ChemicalEngineDicts.clear()
ChemicalEngineDicts.clear_b_aq_part()
ChemicalEngineDicts.cold_start()
ChemicalEngineDicts.converged
ChemicalEngineDicts.delta_G0_reaction()
ChemicalEngineDicts.delta_H0_reaction()
ChemicalEngineDicts.elapsed_time
ChemicalEngineDicts.element_molar_masses
ChemicalEngineDicts.element_names
ChemicalEngineDicts.equilibrate()
ChemicalEngineDicts.gas_fugacity()
ChemicalEngineDicts.gas_fugacity_coefficient()
ChemicalEngineDicts.gas_partial_pressure()
ChemicalEngineDicts.gas_phase_symbol
ChemicalEngineDicts.gas_species_fugacities
ChemicalEngineDicts.gas_species_fugacity_coefficients
ChemicalEngineDicts.gas_species_partial_pressures
ChemicalEngineDicts.get_b_from_formula()
ChemicalEngineDicts.hardness
ChemicalEngineDicts.ionic_strength
ChemicalEngineDicts.is_aqueous_phase()
ChemicalEngineDicts.is_gas_phase()
ChemicalEngineDicts.is_mineral_phase()
ChemicalEngineDicts.log_K()
ChemicalEngineDicts.mass_balance_errors
ChemicalEngineDicts.mass_balance_relative_errors
ChemicalEngineDicts.multiple_species_lower_bound()
ChemicalEngineDicts.multiple_species_upper_bound()
ChemicalEngineDicts.nelements
ChemicalEngineDicts.nphases
ChemicalEngineDicts.nspecies
ChemicalEngineDicts.num_iterations
ChemicalEngineDicts.osmotic_coefficient
ChemicalEngineDicts.pE
ChemicalEngineDicts.pH
ChemicalEngineDicts.phase_amounts
ChemicalEngineDicts.phase_elements_amounts
ChemicalEngineDicts.phase_is_present()
ChemicalEngineDicts.phase_masses
ChemicalEngineDicts.phase_molar_volume
ChemicalEngineDicts.phase_names
ChemicalEngineDicts.phase_sat_indices
ChemicalEngineDicts.phase_species_amounts()
ChemicalEngineDicts.phase_species_ln_activities
ChemicalEngineDicts.phase_species_ln_activity_coefficients
ChemicalEngineDicts.phase_species_lower_bounds
ChemicalEngineDicts.phase_species_moles()
ChemicalEngineDicts.phase_species_upper_bounds
ChemicalEngineDicts.phase_volume_frac
ChemicalEngineDicts.phase_volumes
ChemicalEngineDicts.phases_SI
ChemicalEngineDicts.phases_density
ChemicalEngineDicts.phases_elements_moles
ChemicalEngineDicts.phases_enthalpy
ChemicalEngineDicts.phases_entropy
ChemicalEngineDicts.phases_heat_capacity_const_p
ChemicalEngineDicts.phases_mass
ChemicalEngineDicts.phases_molar_gibbs_energy
ChemicalEngineDicts.phases_molar_volume
ChemicalEngineDicts.phases_moles
ChemicalEngineDicts.phases_sat_index
ChemicalEngineDicts.phases_volume
ChemicalEngineDicts.phases_volume_frac
ChemicalEngineDicts.present_minerals()
ChemicalEngineDicts.present_phases()
ChemicalEngineDicts.pressure
ChemicalEngineDicts.readDbrFromFile()
ChemicalEngineDicts.readDbrFromJsonString()
ChemicalEngineDicts.reequilibrate()
ChemicalEngineDicts.reset_aq_composition()
ChemicalEngineDicts.setB()
ChemicalEngineDicts.setPT()
ChemicalEngineDicts.set_bulk_composition()
ChemicalEngineDicts.set_multiple_species_lower_bound()
ChemicalEngineDicts.set_multiple_species_upper_bound()
ChemicalEngineDicts.set_species_G0()
ChemicalEngineDicts.set_species_lower_bound()
ChemicalEngineDicts.set_species_upper_bound()
ChemicalEngineDicts.set_vector_b()
ChemicalEngineDicts.solid_elements_amounts()
ChemicalEngineDicts.solid_mass_frac
ChemicalEngineDicts.solid_volume_frac
ChemicalEngineDicts.solids_elements_moles()
ChemicalEngineDicts.solids_mass_frac
ChemicalEngineDicts.solids_volume_frac
ChemicalEngineDicts.species_amounts
ChemicalEngineDicts.species_charges
ChemicalEngineDicts.species_chemical_potentials
ChemicalEngineDicts.species_enthalpies
ChemicalEngineDicts.species_entropies
ChemicalEngineDicts.species_gibbs_energies
ChemicalEngineDicts.species_heat_capacities_const_p
ChemicalEngineDicts.species_in_phase
ChemicalEngineDicts.species_ln_activities
ChemicalEngineDicts.species_ln_activity_coefficients
ChemicalEngineDicts.species_ln_concentrations
ChemicalEngineDicts.species_lower_bounds
ChemicalEngineDicts.species_molar_mass
ChemicalEngineDicts.species_molar_volumes
ChemicalEngineDicts.species_mole_fractions
ChemicalEngineDicts.species_moles
ChemicalEngineDicts.species_names
ChemicalEngineDicts.species_upper_bounds
ChemicalEngineDicts.suppress_multiple_phases()
ChemicalEngineDicts.suppress_multiple_species()
ChemicalEngineDicts.suppress_phase()
ChemicalEngineDicts.suppress_species()
ChemicalEngineDicts.system_enthalpy
ChemicalEngineDicts.system_entropy
ChemicalEngineDicts.system_gibbs_energy
ChemicalEngineDicts.system_heat_capacity_const_p
ChemicalEngineDicts.system_mass
ChemicalEngineDicts.system_volume
ChemicalEngineDicts.temperature
ChemicalEngineDicts.vector_b
ChemicalEngineDicts.vector_b_from_formula()
ChemicalEngineDicts.warm_start()
ChemicalEngineDicts.water_activity
ChemicalEngineDicts.writeDbrToFile()
ChemicalEngineDicts.writeDbrToJsonString()
ChemicalEngine
ChemicalEngine.Eh()
ChemicalEngine.aqueousPhaseName()
ChemicalEngine.chemicalPotentials()
ChemicalEngine.converged()
ChemicalEngine.elapsedTime()
ChemicalEngine.elementAmounts()
ChemicalEngine.elementAmountsInPhase()
ChemicalEngine.elementAmountsInPhase_i()
ChemicalEngine.elementAmountsInSpecies()
ChemicalEngine.elementMolarMasses()
ChemicalEngine.elementName()
ChemicalEngine.elementName_i()
ChemicalEngine.equilibrate()
ChemicalEngine.formulaMatrix()
ChemicalEngine.gasPhaseName()
ChemicalEngine.indexElement()
ChemicalEngine.indexFirstSpeciesInPhase()
ChemicalEngine.indexFirstSpeciesInPhase_i()
ChemicalEngine.indexPhase()
ChemicalEngine.indexPhaseAll()
ChemicalEngine.indexPhaseWithSpecies()
ChemicalEngine.indexSpecies()
ChemicalEngine.indexSpeciesAll()
ChemicalEngine.indexSpeciesMap()
ChemicalEngine.initialize()
ChemicalEngine.initializeFromJsonStrings()
ChemicalEngine.ionicStrength()
ChemicalEngine.lnActivities()
ChemicalEngine.lnActivityCoefficients()
ChemicalEngine.lnConcentrations()
ChemicalEngine.moleFractions()
ChemicalEngine.numElements()
ChemicalEngine.numIterations()
ChemicalEngine.numPhases()
ChemicalEngine.numSpecies()
ChemicalEngine.numSpeciesInPhase()
ChemicalEngine.numSpeciesInPhase_i()
ChemicalEngine.options
ChemicalEngine.pH()
ChemicalEngine.pe()
ChemicalEngine.phaseAmount()
ChemicalEngine.phaseAmount_i()
ChemicalEngine.phaseAmounts()
ChemicalEngine.phaseDensities()
ChemicalEngine.phaseDensity()
ChemicalEngine.phaseDensity_i()
ChemicalEngine.phaseEnthalpies()
ChemicalEngine.phaseEnthalpy()
ChemicalEngine.phaseEnthalpy_i()
ChemicalEngine.phaseEntropies()
ChemicalEngine.phaseEntropy()
ChemicalEngine.phaseEntropy_i()
ChemicalEngine.phaseHeatCapacitiesConstP()
ChemicalEngine.phaseHeatCapacityConstP()
ChemicalEngine.phaseHeatCapacityConstP_i()
ChemicalEngine.phaseMass()
ChemicalEngine.phaseMass_i()
ChemicalEngine.phaseMasses()
ChemicalEngine.phaseMolarEnthalpy()
ChemicalEngine.phaseMolarEnthalpy_i()
ChemicalEngine.phaseMolarEntropy()
ChemicalEngine.phaseMolarEntropy_i()
ChemicalEngine.phaseMolarGibbsEnergy()
ChemicalEngine.phaseMolarGibbsEnergy_i()
ChemicalEngine.phaseMolarHeatCapacityConstP()
ChemicalEngine.phaseMolarHeatCapacityConstP_i()
ChemicalEngine.phaseMolarVolume()
ChemicalEngine.phaseMolarVolume_i()
ChemicalEngine.phaseName()
ChemicalEngine.phaseName_i()
ChemicalEngine.phaseSatIndex()
ChemicalEngine.phaseSatIndex_i()
ChemicalEngine.phaseSatIndices()
ChemicalEngine.phaseSpecificEnthalpy()
ChemicalEngine.phaseSpecificEnthalpy_i()
ChemicalEngine.phaseSpecificEntropy()
ChemicalEngine.phaseSpecificEntropy_i()
ChemicalEngine.phaseSpecificGibbsEnergy()
ChemicalEngine.phaseSpecificGibbsEnergy_i()
ChemicalEngine.phaseSpecificHeatCapacityConstP()
ChemicalEngine.phaseSpecificHeatCapacityConstP_i()
ChemicalEngine.phaseSpecificVolume()
ChemicalEngine.phaseSpecificVolume_i()
ChemicalEngine.phaseVolume()
ChemicalEngine.phaseVolume_i()
ChemicalEngine.phaseVolumes()
ChemicalEngine.pressure()
ChemicalEngine.readDbrFromFile()
ChemicalEngine.readDbrFromJsonString()
ChemicalEngine.reequilibrate()
ChemicalEngine.setB()
ChemicalEngine.setColdStart()
ChemicalEngine.setPT()
ChemicalEngine.setSpeciesAmount()
ChemicalEngine.setSpeciesAmount_i()
ChemicalEngine.setSpeciesAmounts()
ChemicalEngine.setSpeciesLowerLimit()
ChemicalEngine.setSpeciesLowerLimit_i()
ChemicalEngine.setSpeciesLowerLimits()
ChemicalEngine.setSpeciesUpperLimit()
ChemicalEngine.setSpeciesUpperLimit_i()
ChemicalEngine.setSpeciesUpperLimits()
ChemicalEngine.setStandardMolarGibbsEnergy()
ChemicalEngine.setStandardMolarGibbsEnergy_i()
ChemicalEngine.setWarmStart()
ChemicalEngine.speciesAmount()
ChemicalEngine.speciesAmount_i()
ChemicalEngine.speciesAmounts()
ChemicalEngine.speciesCharge()
ChemicalEngine.speciesCharge_i()
ChemicalEngine.speciesLowerLimits()
ChemicalEngine.speciesMolalities()
ChemicalEngine.speciesMolarMasses()
ChemicalEngine.speciesName()
ChemicalEngine.speciesName_i()
ChemicalEngine.speciesUpperLimits()
ChemicalEngine.standardMolarEnthalpy()
ChemicalEngine.standardMolarEnthalpy_i()
ChemicalEngine.standardMolarEntropy()
ChemicalEngine.standardMolarEntropy_i()
ChemicalEngine.standardMolarGibbsEnergy()
ChemicalEngine.standardMolarGibbsEnergy_i()
ChemicalEngine.standardMolarHeatCapacityConstP()
ChemicalEngine.standardMolarHeatCapacityConstP_i()
ChemicalEngine.standardMolarVolume()
ChemicalEngine.standardMolarVolume_i()
ChemicalEngine.systemEnthalpy()
ChemicalEngine.systemEntropy()
ChemicalEngine.systemGibbsEnergy()
ChemicalEngine.systemHeatCapacityConstP()
ChemicalEngine.systemMass()
ChemicalEngine.systemVolume()
ChemicalEngine.temperature()
ChemicalEngine.writeDbrToFile()
ChemicalEngine.writeDbrToJsonString()
parse_chemical_formula()
Material
Material.add()
Material.b()
Material.b_dict()
Material.elements()
Material.mass_kg()
Material.min_amount
Material.moles()
Material.name
Material.scale()
Material.scale_to_mass()
Material.scale_to_moles()
Material.set_quantity()
Material.total()
xGEMS::ChemicalEngine
ChemicalEngine()
~ChemicalEngine()
operator=()
reallocateEngineArrays()
initialize()
initializeFromJsonStrings()
readDbrFromFile()
readDbrFromJsonString()
writeDbrToFile()
writeDbrToJsonString()
numElements()
numSpecies()
numPhases()
numSpeciesInPhase()
numSpeciesInPhase_i()
elementName()
elementName_i()
speciesName()
speciesName_i()
speciesCharge()
speciesCharge_i()
phaseName()
phaseName_i()
indexElement()
indexSpecies()
indexSpeciesMap()
indexSpeciesAll()
indexPhase()
indexPhaseAll()
indexPhaseWithSpecies()
indexFirstSpeciesInPhase()
indexFirstSpeciesInPhase_i()
elementMolarMasses()
speciesMolarMasses()
formulaMatrix()
setSpeciesAmounts()
setSpeciesAmount()
setSpeciesAmount_i()
setOptions()
options()
setWarmStart()
setColdStart()
setSpeciesUpperLimit()
setSpeciesLowerLimit()
setSpeciesUpperLimit_i()
setSpeciesLowerLimit_i()
setStandardMolarGibbsEnergy()
setStandardMolarGibbsEnergy_i()
setSpeciesUpperLimits()
setSpeciesLowerLimits()
setPT()
setB()
reequilibrate()
equilibrate()
converged()
numIterations()
elapsedTime()
temperature()
pressure()
elementAmounts()
elementAmountsInPhase()
elementAmountsInPhase_i()
elementAmountsInSpecies()
speciesAmounts()
speciesAmount()
speciesAmount_i()
speciesUpperLimits()
speciesLowerLimits()
speciesMolalities()
moleFractions()
lnActivityCoefficients()
lnActivities()
lnConcentrations()
chemicalPotentials()
standardMolarGibbsEnergy()
standardMolarGibbsEnergy_i()
standardMolarEnthalpy()
standardMolarEnthalpy_i()
standardMolarVolume()
standardMolarVolume_i()
standardMolarEntropy()
standardMolarEntropy_i()
standardMolarHeatCapacityConstP()
standardMolarHeatCapacityConstP_i()
phaseMolarGibbsEnergy()
phaseMolarGibbsEnergy_i()
phaseMolarEnthalpy()
phaseMolarEnthalpy_i()
phaseMolarVolume()
phaseMolarVolume_i()
phaseMolarEntropy()
phaseMolarEntropy_i()
phaseMolarHeatCapacityConstP()
phaseMolarHeatCapacityConstP_i()
phaseSpecificGibbsEnergy()
phaseSpecificGibbsEnergy_i()
phaseSpecificEnthalpy()
phaseSpecificEnthalpy_i()
phaseSpecificVolume()
phaseSpecificVolume_i()
phaseSpecificEntropy()
phaseSpecificEntropy_i()
phaseSpecificHeatCapacityConstP()
phaseSpecificHeatCapacityConstP_i()
phaseDensities()
phaseDensity()
phaseDensity_i()
phaseMasses()
phaseMass()
phaseMass_i()
phaseAmounts()
phaseAmount()
phaseAmount_i()
phaseVolumes()
phaseVolume()
phaseVolume_i()
phaseEnthalpies()
phaseEnthalpy()
phaseEnthalpy_i()
phaseEntropies()
phaseEntropy()
phaseEntropy_i()
phaseHeatCapacitiesConstP()
phaseHeatCapacityConstP()
phaseHeatCapacityConstP_i()
phaseSatIndices()
phaseSatIndex()
phaseSatIndex_i()
systemMass()
systemVolume()
ionicStrength()
pH()
pe()
Eh()
waterActivity()
osmoticCoefficient()
systemGibbsEnergy()
systemEnthalpy()
systemEntropy()
systemHeatCapacityConstP()
massBalanceErrors()
massBalanceRelativeErrors()
aqueousPhaseName()
gasPhaseName()
phaseIsPresent()
presentPhases()
logK()
deltaG0Reaction()
deltaH0Reaction()
pimpl
xGEMS::ChemicalEngineMaps
ChemicalEngineMaps()
cold_start()
warm_start()
clear()
set_species_G0()
set_bulk_composition()
reset_aq_composition()
nelements()
nphases()
nspecies()
element_names()
species_names()
phase_names()
aq_phase_symbol()
gas_phase_symbol()
element_molar_masses()
species_in_phase()
species_charges()
species_molar_mass()
species_molar_volumes()
bulk_composition()
pE()
ionic_strength()
system_volume()
system_mass()
num_iterations()
elapsed_time()
system_gibbs_energy()
system_enthalpy()
system_entropy()
system_heat_capacity_const_p()
mass_balance_errors()
mass_balance_relative_errors()
water_activity()
osmotic_coefficient()
hardness()
gas_species_partial_pressures()
gas_species_fugacities()
gas_species_fugacity_coefficients()
gas_partial_pressure()
gas_fugacity()
gas_fugacity_coefficient()
log_K()
delta_G0_reaction()
delta_H0_reaction()
phase_is_present()
present_phases()
present_minerals()
is_aqueous_phase()
is_gas_phase()
is_mineral_phase()
phases_molar_volume()
phase_sat_indices()
phases_density()
phases_enthalpy()
phases_entropy()
phases_molar_gibbs_energy()
phases_heat_capacity_const_p()
aq_elements_molarity()
aq_elements_molality()
aq_species_molarity()
aq_species_molality()
aq_elements_moles()
solids_elements_moles()
phases_elements_moles()
phases_moles()
species_moles()
species_ln_activities()
species_ln_activity_coefficients()
species_mole_fractions()
species_ln_concentrations()
species_chemical_potentials()
species_gibbs_energies()
species_enthalpies()
species_entropies()
species_heat_capacities_const_p()
species_upper_bounds()
species_lower_bounds()
phase_species_moles()
solids_mass_frac()
solids_volume_frac()
aq_volume_frac()
phases_volume()
phases_mass()
phases_volume_frac()
add_multiple_species_amt()
add_species_amt()
add_element_amt()
add_multiple_elements_amt()
add_amt_from_formula()
get_b_from_formula()
set_multiple_species_lower_bound()
set_multiple_species_upper_bound()
set_species_lower_bound()
set_species_upper_bound()
suppress_phase()
suppress_multiple_phases()
suppress_species()
suppress_multiple_species()
activate_phase()
activate_multiple_phases()
activate_multiple_species()
activate_species()
phase_species_ln_activities()
phase_species_ln_activity_coefficients()
phase_species_upper_bounds()
phase_species_lower_bounds()
T
P
to_map()
to_phase_species_map()
clear_vector()
init_caches()
b_amounts
input_file
gem
m_element_names
m_species_names
m_phase_names
m_aq_phase_symbol
m_gas_phase_symbol
m_element_molar_masses
m_species_in_phase
m_species_charges
m_species_molar_mass
m_species_molar_volumes
operator<<
xGEMS::ChemicalEngineOptions
warmstart
print_zero_amounts
xGEMS::Material::Constituent
moles()
massKg()
elementMoles()
name
formula
formula_mass_kg
value
units
react_ext
xGEMS::Material
Material()
add()
operator()()
operator+()
scale()
scaleToMass()
scaleToMoles()
setQuantity()
elements()
b()
bMap()
total()
size()
minAmount()
setMinAmount()
name()
setName()
toString()
adapter()
formulaMassKg()
buildConstituent()
adapter_
name_
constituents_
min_amount_
xGEMS
ValuesMap
PhaseValuesMap
Vector
VectorXd
VectorXi
VectorRef
VectorXdRef
VectorXiRef
VectorConstRef
VectorXdConstRef
VectorXiConstRef
VectorMap
VectorXdMap
VectorXiMap
VectorConstMap
VectorXdConstMap
VectorXiConstMap
Matrix
MatrixXd
MatrixXi
MatrixRef
MatrixXdRef
MatrixXiRef
MatrixConstRef
MatrixXdConstRef
MatrixXiConstRef
MatrixMap
MatrixXdMap
MatrixXiMap
MatrixConstMap
MatrixXdConstMap
MatrixXiConstMap
Index
ElementMap
update_loggers()
printWrappedTable()
operator<<()
parseChemicalFormula()
_status_encoder
P_std
all
A powerful tool for Gibbs-energy minimization and equilibrium computations.