Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
AddSpatialReactionSolverAction Class Reference

Action that sets up a spatial reaction solver. More...

#include <AddSpatialReactionSolverAction.h>

Inheritance diagram for AddSpatialReactionSolverAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 AddSpatialReactionSolverAction (const InputParameters &parameters)
 
virtual void act () override
 
void timedAct ()
 
virtual void addRelationshipManagers (Moose::RelationshipManagerType when_type)
 
MooseObjectName uniqueActionName () const
 
const std::string & specificTaskName () const
 
const std::set< std::string > & getAllTasks () const
 
void appendTask (const std::string &task)
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
PerfGraph & perfGraph ()
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

void addAuxSpecies (const std::string &var_name, const std::string &species_name, const std::string &unit)
 Adds AuxVariable and AuxKernel that will record species concentrations. More...
 
bool addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
 
void associateWithParameter (const std::string &param_name, InputParameters &params) const
 
void associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

std::string _registered_identifier
 
std::string _specific_task_name
 
std::set< std::string > _all_tasks
 
ActionWarehouse & _awh
 
const std::string & _current_task
 
std::shared_ptr< MooseMesh > & _mesh
 
std::shared_ptr< MooseMesh > & _displaced_mesh
 
std::shared_ptr< FEProblemBase > & _problem
 
PerfID _act_timer
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Detailed Description

Action that sets up a spatial reaction solver.

Definition at line 17 of file AddSpatialReactionSolverAction.h.

Constructor & Destructor Documentation

◆ AddSpatialReactionSolverAction()

AddSpatialReactionSolverAction::AddSpatialReactionSolverAction ( const InputParameters &  parameters)

Definition at line 35 of file AddSpatialReactionSolverAction.C.

36  : AddGeochemistrySolverAction(params)
37 {
38 }
AddGeochemistrySolverAction::AddGeochemistrySolverAction
AddGeochemistrySolverAction(const InputParameters &parameters)
Definition: AddGeochemistrySolverAction.C:134

Member Function Documentation

◆ act()

void AddSpatialReactionSolverAction::act ( )
overridevirtual

Reimplemented from AddGeochemistrySolverAction.

Definition at line 41 of file AddSpatialReactionSolverAction.C.

42 {
43  // create Output and Aux objects
44  AddGeochemistrySolverAction::act();
45 
46  // Create a "solve=false" FEProblem, if appropriate
47  if (_current_task == "create_problem")
48  {
49  const std::string class_name = "FEProblem";
50  InputParameters params = _factory.getValidParams(class_name);
51  params.set<MooseMesh *>("mesh") = _mesh.get();
52  params.set<bool>("use_nonlinear") = true;
53  params.set<bool>("solve") = getParam<bool>("include_moose_solve");
54  _problem = _factory.create<FEProblemBase>(class_name, "Problem", params);
55  _problem->setKernelCoverageCheck(getParam<bool>("include_moose_solve")
56  ? FEProblemBase::CoverageCheckMode::TRUE
57  : FEProblemBase::CoverageCheckMode::FALSE);
58  }
59  else if (_current_task == "add_geochemistry_reactor")
60  {
61  const std::string class_name = "GeochemistrySpatialReactor";
62  auto params = _factory.getValidParams(class_name);
63  // Only pass parameters that were supplied to this action
64 
65  // Block and Boundary params
66  if (isParamValid("block"))
67  params.set<std::vector<SubdomainName>>("block") =
68  getParam<std::vector<SubdomainName>>("block");
69  if (isParamValid("boundary"))
70  params.set<std::vector<BoundaryName>>("boundary") =
71  getParam<std::vector<BoundaryName>>("boundary");
72 
73  // GeochemistryReactorBase::sharedParams
74  if (isParamValid("swap_out_of_basis"))
75  params.set<std::vector<std::string>>("swap_out_of_basis") =
76  getParam<std::vector<std::string>>("swap_out_of_basis");
77  if (isParamValid("swap_into_basis"))
78  params.set<std::vector<std::string>>("swap_into_basis") =
79  getParam<std::vector<std::string>>("swap_into_basis");
80  params.set<MultiMooseEnum>("constraint_meaning") =
81  getParam<MultiMooseEnum>("constraint_meaning");
82  params.set<std::vector<std::string>>("constraint_species") =
83  getParam<std::vector<std::string>>("constraint_species");
84  params.set<std::vector<Real>>("constraint_value") =
85  getParam<std::vector<Real>>("constraint_value");
86  params.set<MultiMooseEnum>("constraint_unit") = getParam<MultiMooseEnum>("constraint_unit");
87  params.set<Real>("max_ionic_strength") = getParam<Real>("max_ionic_strength");
88  params.set<unsigned>("extra_iterations_to_make_consistent") =
89  getParam<unsigned>("extra_iterations_to_make_consistent");
90  params.set<std::string>("charge_balance_species") =
91  getParam<std::string>("charge_balance_species");
92  if (isParamValid("prevent_precipitation"))
93  params.set<std::vector<std::string>>("prevent_precipitation") =
94  getParam<std::vector<std::string>>("prevent_precipitation");
95  params.set<Real>("abs_tol") = getParam<Real>("abs_tol");
96  params.set<Real>("rel_tol") = getParam<Real>("rel_tol");
97  params.set<Real>("min_initial_molality") = getParam<Real>("min_initial_molality");
98  params.set<unsigned>("max_iter") = getParam<unsigned>("max_iter");
99  params.set<Real>("max_initial_residual") = getParam<Real>("max_initial_residual");
100  params.set<Real>("swap_threshold") = getParam<Real>("swap_threshold");
101  params.set<unsigned>("max_swaps_allowed") = getParam<unsigned>("max_swaps_allowed");
102  params.set<unsigned>("ramp_max_ionic_strength_initial") =
103  getParam<unsigned>("ramp_max_ionic_strength_initial");
104  params.set<bool>("ionic_str_using_basis_only") = getParam<bool>("ionic_str_using_basis_only");
105  params.set<bool>("stoichiometric_ionic_str_using_Cl_only") =
106  getParam<bool>("stoichiometric_ionic_str_using_Cl_only");
107 
108  // GeochemistryReactorBase non-shared params
109  params.set<UserObjectName>("model_definition") = getParam<UserObjectName>("model_definition");
110  params.set<Real>("stoichiometry_tolerance") = getParam<Real>("stoichiometry_tolerance");
111 
112  // GeochemistrySpatialReactor::sharedParams
113  params.set<unsigned>("ramp_max_ionic_strength_subsequent") =
114  getParam<unsigned>("ramp_max_ionic_strength_subsequent");
115  params.set<Real>("initial_temperature") = getParam<Real>("initial_temperature");
116  params.applySpecificParameters(parameters(), {"temperature"});
117  params.set<Real>("close_system_at_time") = getParam<Real>("close_system_at_time");
118  if (isParamValid("remove_fixed_activity_name"))
119  params.set<std::vector<std::string>>("remove_fixed_activity_name") =
120  getParam<std::vector<std::string>>("remove_fixed_activity_name");
121  if (isParamValid("remove_fixed_activity_time"))
122  params.set<std::vector<Real>>("remove_fixed_activity_time") =
123  getParam<std::vector<Real>>("remove_fixed_activity_time");
124  if (isParamValid("source_species_names"))
125  params.set<std::vector<std::string>>("source_species_names") =
126  getParam<std::vector<std::string>>("source_species_names");
127  if (isParamValid("source_species_rates"))
128  params.applySpecificParameters(parameters(), {"source_species_rates"});
129  if (isParamValid("controlled_activity_name"))
130  params.set<std::vector<std::string>>("controlled_activity_name") =
131  getParam<std::vector<std::string>>("controlled_activity_name");
132  if (isParamValid("controlled_activity_value"))
133  params.applySpecificParameters(parameters(), {"controlled_activity_value"});
134  params.set<bool>("evaluate_kinetic_rates_always") =
135  getParam<bool>("evaluate_kinetic_rates_always");
136  if (isParamValid("kinetic_species_name"))
137  params.set<std::vector<std::string>>("kinetic_species_name") =
138  getParam<std::vector<std::string>>("kinetic_species_name");
139  if (isParamValid("kinetic_species_initial_value"))
140  params.set<std::vector<Real>>("kinetic_species_initial_value") =
141  getParam<std::vector<Real>>("kinetic_species_initial_value");
142  if (isParamValid("kinetic_species_unit"))
143  params.set<MultiMooseEnum>("kinetic_species_unit") =
144  getParam<MultiMooseEnum>("kinetic_species_unit");
145  params.set<bool>("adaptive_timestepping") = getParam<bool>("adaptive_timestepping");
146  params.set<Real>("dt_min") = getParam<Real>("dt_min");
147  params.set<Real>("dt_dec") = getParam<Real>("dt_dec");
148  params.set<Real>("dt_inc") = getParam<Real>("dt_inc");
149  params.set<ExecFlagEnum>("execute_on") = {EXEC_TIMESTEP_END};
150  _problem->addUserObject(
151  class_name, getParam<UserObjectName>("geochemistry_reactor_name"), params);
152  }
153 }
MooseMesh
InputParameters::applySpecificParameters
void applySpecificParameters(const InputParameters &common, const std::vector< std::string > &include, bool allow_private=false)
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Factory::create
std::shared_ptr< MooseObject > create(const std::string &obj_name, const std::string &name, const InputParameters &parameters, THREAD_ID tid=0, bool print_deprecated=true)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
EXEC_TIMESTEP_END
const ExecFlagType EXEC_TIMESTEP_END
Action::isParamValid
bool isParamValid(const std::string &name) const
Action::_factory
Factory & _factory
Action::getParam
const T & getParam(const std::string &name) const
Action::_current_task
const std::string & _current_task
Action::_mesh
std::shared_ptr< MooseMesh > & _mesh
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Action::_problem
std::shared_ptr< FEProblemBase > & _problem
Action::parameters
const InputParameters & parameters() const

◆ addAuxSpecies()

void AddGeochemistrySolverAction::addAuxSpecies ( const std::string &  var_name,
const std::string &  species_name,
const std::string &  unit 
)
protectedinherited

Adds AuxVariable and AuxKernel that will record species concentrations.

Parameters
var_nameAuxVariable name
species_nameSpecies name
unitUnit choice: defined in GeochemistryQuantityAux

Definition at line 255 of file AddGeochemistrySolverAction.C.

Referenced by AddGeochemistrySolverAction::act().

258 {
259  // add AuxVariable
260  auto var_params = _factory.getValidParams("MooseVariable");
261  _problem->addAuxVariable("MooseVariable", var_name, var_params);
262  // add AuxKernel
263  const std::string class_name = "GeochemistryQuantityAux";
264  auto params = _factory.getValidParams(class_name);
265  params.set<std::string>("species") = species_name;
266  params.set<MooseEnum>("quantity") = quantity;
267  params.set<UserObjectName>("reactor") = getParam<UserObjectName>("geochemistry_reactor_name");
268  params.set<AuxVariableName>("variable") = var_name;
269  params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
270  _problem->addAuxKernel(class_name, var_name, params);
271 }
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
Action::_factory
Factory & _factory
Action::_problem
std::shared_ptr< FEProblemBase > & _problem

◆ validParams()

InputParameters AddSpatialReactionSolverAction::validParams ( )
static

Definition at line 23 of file AddSpatialReactionSolverAction.C.

24 {
25  InputParameters params = AddGeochemistrySolverAction::validParams();
26  params += GeochemistrySpatialReactor::sharedParams();
27  params.addClassDescription(
28  "Action that sets up a spatially-dependent reaction solver. This creates creates a "
29  "spatial geochemistry solver, and adds AuxVariables corresonding to the molalities, "
30  "etc");
31 
32  return params;
33 }
AddGeochemistrySolverAction::validParams
static InputParameters validParams()
Definition: AddGeochemistrySolverAction.C:25
GeochemistrySpatialReactor::sharedParams
static InputParameters sharedParams()
params that are shared with AddTimeDependentReactionSolverAction
Definition: GeochemistrySpatialReactor.C:15
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
The documentation for this class was generated from the following files:
Generated on Sun Apr 13 2025 17:19:17 for https://mooseframework.inl.gov by   doxygen 1.8.14