- charge_balance_speciesCharge balance will be enforced on this basis species. This means that its bulk mole number may be changed from the initial value you provide in order to ensure charge neutrality. After the initial swaps have been performed, this must be in the basis, and it must be provided with a bulk_composition constraint_meaning.
C++ Type:std::string
Controllable:No
Description:Charge balance will be enforced on this basis species. This means that its bulk mole number may be changed from the initial value you provide in order to ensure charge neutrality. After the initial swaps have been performed, this must be in the basis, and it must be provided with a bulk_composition constraint_meaning.
- constraint_meaningMeanings of the numerical values given in constraint_value. kg_solvent_water: can only be applied to H2O and units must be kg. bulk_composition: can be applied to all non-gas species, and represents the total amount of the basis species contained as free species as well as the amount found in secondary species but not in kinetic species, and units must be moles or mass (kg, g, etc). bulk_composition_with_kinetic: can be applied to all non-gas species, and represents the total amount of the basis species contained as free species as well as the amount found in secondary species and in kinetic species, and units must be moles or mass (kg, g, etc). free_concentration: can be applied to all basis species that are not gas and not H2O and not mineral, and represents the total amount of the basis species existing freely (not as secondary species) within the solution, and units must be molal or mass_per_kg_solvent. free_mineral: can be applied to all mineral basis species, and represents the total amount of the mineral existing freely (precipitated) within the solution, and units must be moles, mass or cm3. activity and log10activity: can be applied to basis species that are not gas and not mineral and not sorbing sites, and represents the activity of the basis species (recall pH = -log10activity), and units must be dimensionless. fugacity and log10fugacity: can be applied to gases, and units must be dimensionless
C++ Type:MultiMooseEnum
Controllable:No
Description:Meanings of the numerical values given in constraint_value. kg_solvent_water: can only be applied to H2O and units must be kg. bulk_composition: can be applied to all non-gas species, and represents the total amount of the basis species contained as free species as well as the amount found in secondary species but not in kinetic species, and units must be moles or mass (kg, g, etc). bulk_composition_with_kinetic: can be applied to all non-gas species, and represents the total amount of the basis species contained as free species as well as the amount found in secondary species and in kinetic species, and units must be moles or mass (kg, g, etc). free_concentration: can be applied to all basis species that are not gas and not H2O and not mineral, and represents the total amount of the basis species existing freely (not as secondary species) within the solution, and units must be molal or mass_per_kg_solvent. free_mineral: can be applied to all mineral basis species, and represents the total amount of the mineral existing freely (precipitated) within the solution, and units must be moles, mass or cm3. activity and log10activity: can be applied to basis species that are not gas and not mineral and not sorbing sites, and represents the activity of the basis species (recall pH = -log10activity), and units must be dimensionless. fugacity and log10fugacity: can be applied to gases, and units must be dimensionless
- constraint_speciesNames of the species that have their values fixed to constraint_value with meaning constraint_meaning. All basis species (after swap_into_basis and swap_out_of_basis) must be provided with exactly one constraint. These constraints are used to compute the configuration during the initial problem setup, and in time-dependent simulations they may be modified as time progresses.
C++ Type:std::vector<std::string>
Controllable:No
Description:Names of the species that have their values fixed to constraint_value with meaning constraint_meaning. All basis species (after swap_into_basis and swap_out_of_basis) must be provided with exactly one constraint. These constraints are used to compute the configuration during the initial problem setup, and in time-dependent simulations they may be modified as time progresses.
- constraint_unitUnits of the numerical values given in constraint_value. Dimensionless: should only be used for activity or fugacity constraints. Moles: mole number. Molal: moles per kg solvent water. kg: kilograms. g: grams. mg: milligrams. ug: micrograms. kg_per_kg_solvent: kilograms per kg solvent water. g_per_kg_solvent: grams per kg solvent water. mg_per_kg_solvent: milligrams per kg solvent water. ug_per_kg_solvent: micrograms per kg solvent water. cm3: cubic centimeters
C++ Type:MultiMooseEnum
Controllable:No
Description:Units of the numerical values given in constraint_value. Dimensionless: should only be used for activity or fugacity constraints. Moles: mole number. Molal: moles per kg solvent water. kg: kilograms. g: grams. mg: milligrams. ug: micrograms. kg_per_kg_solvent: kilograms per kg solvent water. g_per_kg_solvent: grams per kg solvent water. mg_per_kg_solvent: milligrams per kg solvent water. ug_per_kg_solvent: micrograms per kg solvent water. cm3: cubic centimeters
- constraint_valueNumerical value of the containts on constraint_species
C++ Type:std::vector<double>
Controllable:No
Description:Numerical value of the containts on constraint_species
- model_definitionThe name of the GeochemicalModelDefinition user object.
C++ Type:UserObjectName
Controllable:No
Description:The name of the GeochemicalModelDefinition user object.
GeochemistrySpatialReactor
This UserObject is usually added via a SpatialReactionSolver Action: please see that page for many examples. This UserObject's purpose is to solve a time-and-space dependent geochemical system.
Advanced users may also add GeochemistrySpatialReactor objects manually to their input files
Input Parameters
- abs_tol1e-10If the residual of the algebraic system (measured in mol) is lower than this value, the Newton process (that finds the aqueous configuration) is deemed to have converged
Default:1e-10
C++ Type:double
Controllable:No
Description:If the residual of the algebraic system (measured in mol) is lower than this value, the Newton process (that finds the aqueous configuration) is deemed to have converged
- adaptive_timesteppingFalseUse adaptive timestepping at each node in an attempt to ensure convergence of the solver. Setting this parameter to false saves some compute time because copying of datastructures is avoided
Default:False
C++ Type:bool
Controllable:No
Description:Use adaptive timestepping at each node in an attempt to ensure convergence of the solver. Setting this parameter to false saves some compute time because copying of datastructures is avoided
- blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
- boundaryThe list of boundaries (ids or names) from the mesh where this boundary condition applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this boundary condition applies
- close_system_at_time0Time at which to 'close' the entire spatial system, that is, change a kg_solvent_water constraint to moles_bulk_water, and all free_molality and free_moles_mineral_species to moles_bulk_species
Default:0
C++ Type:double
Controllable:No
Description:Time at which to 'close' the entire spatial system, that is, change a kg_solvent_water constraint to moles_bulk_water, and all free_molality and free_moles_mineral_species to moles_bulk_species
- controlled_activity_nameThe names of the species that have their activity or fugacity constrained. There should be an equal number of these names as values given in controlled_activity_value. NOTE: if these species are not in the basis, or they do not have an activity (or fugacity) constraint then their activity cannot be controlled: in this case MOOSE will ignore the value you prescribe in controlled_activity_value.
C++ Type:std::vector<std::string>
Controllable:No
Description:The names of the species that have their activity or fugacity constrained. There should be an equal number of these names as values given in controlled_activity_value. NOTE: if these species are not in the basis, or they do not have an activity (or fugacity) constraint then their activity cannot be controlled: in this case MOOSE will ignore the value you prescribe in controlled_activity_value.
- controlled_activity_valueValues of the activity or fugacity of the species in controlled_activity_name list. These should always be positive
C++ Type:std::vector<VariableName>
Controllable:No
Description:Values of the activity or fugacity of the species in controlled_activity_name list. These should always be positive
- dt_dec0.5If a geochemical solve fails, then 'adpative timestepping' at the node is initiated (assuming adaptive_timestepping = true): the time-step at the node is multiplied by this amount, and the solve process re-tried
Default:0.5
C++ Type:double
Controllable:No
Description:If a geochemical solve fails, then 'adpative timestepping' at the node is initiated (assuming adaptive_timestepping = true): the time-step at the node is multiplied by this amount, and the solve process re-tried
- dt_inc1.1If a geochemical solve suceeds during adpative timestepping at a node, then the time-step at the node is multiplied by this amount before performing the next adaptive timestep
Default:1.1
C++ Type:double
Controllable:No
Description:If a geochemical solve suceeds during adpative timestepping at a node, then the time-step at the node is multiplied by this amount before performing the next adaptive timestep
- dt_min1e-10If, during adaptive timestepping at a node, the time-step fails below this value, MOOSE will give up trying to solve the geochemical system. Optimally, you should set this value bearing abs_tol in mind because as dt changes, the initial value of the residual will also typically change. For example, if you set dt_min very small relative to abs_tol MOOSE may think the system has converged just because dt is small. Also, bear in mind your typical timestep size: if dt_min < 1E-16*typical_dt then you will run out of precision
Default:1e-10
C++ Type:double
Controllable:No
Description:If, during adaptive timestepping at a node, the time-step fails below this value, MOOSE will give up trying to solve the geochemical system. Optimally, you should set this value bearing abs_tol in mind because as dt changes, the initial value of the residual will also typically change. For example, if you set dt_min very small relative to abs_tol MOOSE may think the system has converged just because dt is small. Also, bear in mind your typical timestep size: if dt_min < 1E-16*typical_dt then you will run out of precision
- evaluate_kinetic_rates_alwaysTrueIf true, then, evaluate the kinetic rates at every Newton step during the solve using the current values of molality, activity, etc (ie, implement an implicit solve). If false, then evaluate the kinetic rates using the values of molality, activity, etc, at the start of the current time step (ie, implement an explicit solve)
Default:True
C++ Type:bool
Controllable:No
Description:If true, then, evaluate the kinetic rates at every Newton step during the solve using the current values of molality, activity, etc (ie, implement an implicit solve). If false, then evaluate the kinetic rates using the values of molality, activity, etc, at the start of the current time step (ie, implement an explicit solve)
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.
- extra_iterations_to_make_consistent0Extra iterations to make the molalities, activities, etc, consistent before commencing the Newton process to find the aqueous configuration
Default:0
C++ Type:unsigned int
Controllable:No
Description:Extra iterations to make the molalities, activities, etc, consistent before commencing the Newton process to find the aqueous configuration
- initial_temperature25Temperature at which the initial system is equilibrated. This is uniform over the entire mesh.
Default:25
C++ Type:double
Controllable:No
Description:Temperature at which the initial system is equilibrated. This is uniform over the entire mesh.
- ionic_str_using_basis_onlyFalseIf set to true, ionic strength and stoichiometric ionic strength will be computed using only the basis molalities, ignoring molalities of equilibrium species. Since basis molality is usually greater than equilibrium molality, and the whole Debye-Huckel concept of activity coefficients depending on ionic strength is only approximate in practice, setting this parameter true often results in a reasonable approximation. It can aid in convergence since it eliminates problems associated with unphysical huge equilibrium molalities that can occur during Newton iteration to the solution
Default:False
C++ Type:bool
Controllable:No
Description:If set to true, ionic strength and stoichiometric ionic strength will be computed using only the basis molalities, ignoring molalities of equilibrium species. Since basis molality is usually greater than equilibrium molality, and the whole Debye-Huckel concept of activity coefficients depending on ionic strength is only approximate in practice, setting this parameter true often results in a reasonable approximation. It can aid in convergence since it eliminates problems associated with unphysical huge equilibrium molalities that can occur during Newton iteration to the solution
- kinetic_species_initial_valueInitial number of moles, mass or volume (depending on kinetic_species_unit) for each of the species named in kinetic_species_name
C++ Type:std::vector<double>
Controllable:No
Description:Initial number of moles, mass or volume (depending on kinetic_species_unit) for each of the species named in kinetic_species_name
- kinetic_species_nameNames of the kinetic species given initial values in kinetic_species_initial_value
C++ Type:std::vector<std::string>
Controllable:No
Description:Names of the kinetic species given initial values in kinetic_species_initial_value
- kinetic_species_unitUnits of the numerical values given in kinetic_species_initial_value. Moles: mole number. kg: kilograms. g: grams. mg: milligrams. ug: micrograms. cm3: cubic centimeters
C++ Type:MultiMooseEnum
Controllable:No
Description:Units of the numerical values given in kinetic_species_initial_value. Moles: mole number. kg: kilograms. g: grams. mg: milligrams. ug: micrograms. cm3: cubic centimeters
- max_initial_residual1000Attempt to alter the initial-guess molalities so that the initial residual for the Newton process (that finds the aqueous configuration) is less than this number of moles
Default:1000
C++ Type:double
Controllable:No
Description:Attempt to alter the initial-guess molalities so that the initial residual for the Newton process (that finds the aqueous configuration) is less than this number of moles
- max_ionic_strength3Maximum value of ionic strength
Default:3
C++ Type:double
Controllable:No
Description:Maximum value of ionic strength
- max_iter100Maximum number of Newton iterations allowed when finding the aqueous configuration
Default:100
C++ Type:unsigned int
Controllable:No
Description:Maximum number of Newton iterations allowed when finding the aqueous configuration
- max_swaps_allowed20Maximum number of swaps allowed during a single attempt at finding the aqueous configuration. Usually only a handful of swaps are used: this parameter prevents endless cyclic swapping that prevents the algorithm from progressing
Default:20
C++ Type:unsigned int
Controllable:No
Description:Maximum number of swaps allowed during a single attempt at finding the aqueous configuration. Usually only a handful of swaps are used: this parameter prevents endless cyclic swapping that prevents the algorithm from progressing
- min_initial_molality1e-20Minimum value of the initial-guess molality used in the Newton process to find the aqueous configuration
Default:1e-20
C++ Type:double
Controllable:No
Description:Minimum value of the initial-guess molality used in the Newton process to find the aqueous configuration
- prevent_precipitationMineral species in this list will be prevented from precipitating, irrespective of their saturation index (unless they are initially in the basis)
C++ Type:std::vector<std::string>
Controllable:No
Description:Mineral species in this list will be prevented from precipitating, irrespective of their saturation index (unless they are initially in the basis)
- ramp_max_ionic_strength_initial20The number of iterations over which to progressively increase the maximum ionic strength (from zero to max_ionic_strength) during the initial equilibration. Increasing this can help in convergence of the Newton process, at the cost of spending more time finding the aqueous configuration.
Default:20
C++ Type:unsigned int
Controllable:No
Description:The number of iterations over which to progressively increase the maximum ionic strength (from zero to max_ionic_strength) during the initial equilibration. Increasing this can help in convergence of the Newton process, at the cost of spending more time finding the aqueous configuration.
- ramp_max_ionic_strength_subsequent0The number of iterations over which to progressively increase the maximum ionic strength (from zero to max_ionic_strength) during time-stepping. Unless a great deal occurs in each time step, this parameter can be set quite small
Default:0
C++ Type:unsigned int
Controllable:No
Description:The number of iterations over which to progressively increase the maximum ionic strength (from zero to max_ionic_strength) during time-stepping. Unless a great deal occurs in each time step, this parameter can be set quite small
- rel_tol1e-200If the residual of the algebraic system (measured in mol) is lower than this value times the initial residual, the Newton process (that finds the aqueous configuration) is deemed to have converged
Default:1e-200
C++ Type:double
Controllable:No
Description:If the residual of the algebraic system (measured in mol) is lower than this value times the initial residual, the Newton process (that finds the aqueous configuration) is deemed to have converged
- remove_fixed_activity_nameThe name of the species that should have their activity or fugacity constraint removed at time given in remove_fixed_activity_time. There should be an equal number of these names as times given in remove_fixed_activity_time. Each of these must be in the basis and have an activity or fugacity constraint
C++ Type:std::vector<std::string>
Controllable:No
Description:The name of the species that should have their activity or fugacity constraint removed at time given in remove_fixed_activity_time. There should be an equal number of these names as times given in remove_fixed_activity_time. Each of these must be in the basis and have an activity or fugacity constraint
- remove_fixed_activity_timeThe times at which the species in remove_fixed_activity_name should have their activity or fugacity constraint removed.
C++ Type:std::vector<double>
Controllable:No
Description:The times at which the species in remove_fixed_activity_name should have their activity or fugacity constraint removed.
- source_species_namesThe name of the species that are added at rates given in source_species_rates. There must be an equal number of these as source_species_rates.
C++ Type:std::vector<std::string>
Controllable:No
Description:The name of the species that are added at rates given in source_species_rates. There must be an equal number of these as source_species_rates.
- source_species_ratesRates, in mols/time_unit, of addition of the species with names given in source_species_names. A negative value corresponds to removing a species: be careful that you don't cause negative mass problems!
C++ Type:std::vector<VariableName>
Controllable:No
Description:Rates, in mols/time_unit, of addition of the species with names given in source_species_names. A negative value corresponds to removing a species: be careful that you don't cause negative mass problems!
- stoichiometric_ionic_str_using_Cl_onlyFalseIf set to true, the stoichiometric ionic strength will be set equal to Cl- molality (or max_ionic_strength if the Cl- molality is too big). This flag overrides ionic_str_using_basis_molality_only
Default:False
C++ Type:bool
Controllable:No
Description:If set to true, the stoichiometric ionic strength will be set equal to Cl- molality (or max_ionic_strength if the Cl- molality is too big). This flag overrides ionic_str_using_basis_molality_only
- stoichiometry_tolerance1e-06Swapping involves inverting matrices via a singular value decomposition. During this process: (1) if abs(singular value) < stoi_tol * L1norm(singular values), then the matrix is deemed singular (so the basis swap is deemed invalid); (2) if abs(any stoichiometric coefficient) < stoi_tol then it is set to zero.
Default:1e-06
C++ Type:double
Controllable:No
Description:Swapping involves inverting matrices via a singular value decomposition. During this process: (1) if abs(singular value) < stoi_tol * L1norm(singular values), then the matrix is deemed singular (so the basis swap is deemed invalid); (2) if abs(any stoichiometric coefficient) < stoi_tol then it is set to zero.
- swap_into_basisSpecies that should be removed from the model_definition's equilibrium species list and added to the basis. There must be the same number of species in swap_out_of_basis and swap_into_basis. These swaps are performed before any other computations during the initial problem setup. If this list contains more than one species, the swapping is performed one-by-one, starting with the first pair (swap_out_of_basis[0] and swap_into_basis[0]), then the next pair, etc
C++ Type:std::vector<std::string>
Controllable:No
Description:Species that should be removed from the model_definition's equilibrium species list and added to the basis. There must be the same number of species in swap_out_of_basis and swap_into_basis. These swaps are performed before any other computations during the initial problem setup. If this list contains more than one species, the swapping is performed one-by-one, starting with the first pair (swap_out_of_basis[0] and swap_into_basis[0]), then the next pair, etc
- swap_out_of_basisSpecies that should be removed from the model_definition's basis and be replaced with the swap_into_basis species
C++ Type:std::vector<std::string>
Controllable:No
Description:Species that should be removed from the model_definition's basis and be replaced with the swap_into_basis species
- swap_threshold0.1If the molality of a basis species in the algebraic system falls below swap_threshold * abs_tol then it is swapped out of the basis. The dimensions of swap_threshold are 1/kg(solvent water)
Default:0.1
C++ Type:double
Controllable:No
Description:If the molality of a basis species in the algebraic system falls below swap_threshold * abs_tol then it is swapped out of the basis. The dimensions of swap_threshold are 1/kg(solvent water)
- temperature25.0Temperature
Default:25.0
C++ Type:std::vector<VariableName>
Controllable:No
Description:Temperature
- unique_node_executeFalseWhen false (default), block restricted objects will have the execute method called multiple times on a single node if the node lies on a interface between two subdomains.
Default:False
C++ Type:bool
Controllable:No
Description:When false (default), block restricted objects will have the execute method called multiple times on a single node if the node lies on a interface between two subdomains.
Optional Parameters
- allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
- force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
- use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.