https://mooseframework.inl.gov
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
AddTimeIndependentReactionSolverAction Class Reference

Action that sets up a time-independent equilibrium reaction solver. More...

#include <AddTimeIndependentReactionSolverAction.h>

Inheritance diagram for AddTimeIndependentReactionSolverAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 AddTimeIndependentReactionSolverAction (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 * queryParam (const std::string &name) 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 time-independent equilibrium reaction solver.

Definition at line 17 of file AddTimeIndependentReactionSolverAction.h.

Constructor & Destructor Documentation

◆ AddTimeIndependentReactionSolverAction()

AddTimeIndependentReactionSolverAction::AddTimeIndependentReactionSolverAction ( const InputParameters &  parameters)

Definition at line 42 of file AddTimeIndependentReactionSolverAction.C.

44  : AddGeochemistrySolverAction(params)
45 {
46 }
AddGeochemistrySolverAction::AddGeochemistrySolverAction
AddGeochemistrySolverAction(const InputParameters &parameters)
Definition: AddGeochemistrySolverAction.C:134

Member Function Documentation

◆ act()

void AddTimeIndependentReactionSolverAction::act ( )
overridevirtual

Reimplemented from AddGeochemistrySolverAction.

Definition at line 49 of file AddTimeIndependentReactionSolverAction.C.

50 {
51  // create Output and Aux objects
52  AddGeochemistrySolverAction::act();
53 
54  // Set up an arbitrary mesh
55  if (_current_task == "setup_mesh")
56  {
57  const std::string class_name = "GeneratedMesh";
58  InputParameters params = _factory.getValidParams(class_name);
59  params.set<MooseEnum>("dim") = "1";
60  _mesh = _factory.create<MooseMesh>(class_name, "mesh", params);
61  }
62  // Initialize the arbitrary mesh
63  else if (_current_task == "init_mesh")
64  {
65  _mesh->init();
66  }
67  // Create a "solve=false" FEProblem, if appropriate
68  else if (_current_task == "create_problem")
69  {
70  const std::string class_name = "FEProblem";
71  InputParameters params = _factory.getValidParams(class_name);
72  params.set<MooseMesh *>("mesh") = _mesh.get();
73  params.set<bool>("use_nonlinear") = true;
74  params.set<bool>("solve") = getParam<bool>("include_moose_solve");
75  _problem = _factory.create<FEProblemBase>(class_name, "Problem", params);
76  _problem->setKernelCoverageCheck(getParam<bool>("include_moose_solve")
77  ? FEProblemBase::CoverageCheckMode::TRUE
78  : FEProblemBase::CoverageCheckMode::FALSE);
79  }
80  // Set up an arbitrary steady executioner
81  else if (_current_task == "setup_executioner")
82  {
83  const std::string class_name = "Steady";
84  InputParameters params = _factory.getValidParams(class_name);
85  params.set<FEProblemBase *>("_fe_problem_base") = _problem.get();
86  params.set<FEProblem *>("_fe_problem") = (std::dynamic_pointer_cast<FEProblem>(_problem)).get();
87  std::shared_ptr<Executioner> executioner =
88  _factory.create<Executioner>(class_name, "Executioner", params);
89  _app.setExecutioner(std::move(executioner));
90  }
91  else if (_current_task == "add_geochemistry_reactor")
92  {
93  const std::string class_name = "GeochemistryTimeIndependentReactor";
94  auto params = _factory.getValidParams(class_name);
95  // Only pass parameters that were supplied to this action
96  if (isParamValid("block"))
97  params.set<std::vector<SubdomainName>>("block") =
98  getParam<std::vector<SubdomainName>>("block");
99  if (isParamValid("boundary"))
100  params.set<std::vector<BoundaryName>>("boundary") =
101  getParam<std::vector<BoundaryName>>("boundary");
102  params.set<UserObjectName>("model_definition") = getParam<UserObjectName>("model_definition");
103  if (isParamValid("swap_out_of_basis"))
104  params.set<std::vector<std::string>>("swap_out_of_basis") =
105  getParam<std::vector<std::string>>("swap_out_of_basis");
106  if (isParamValid("swap_into_basis"))
107  params.set<std::vector<std::string>>("swap_into_basis") =
108  getParam<std::vector<std::string>>("swap_into_basis");
109  params.set<MultiMooseEnum>("constraint_meaning") =
110  getParam<MultiMooseEnum>("constraint_meaning");
111  params.set<std::vector<std::string>>("constraint_species") =
112  getParam<std::vector<std::string>>("constraint_species");
113  params.set<std::vector<Real>>("constraint_value") =
114  getParam<std::vector<Real>>("constraint_value");
115  params.set<MultiMooseEnum>("constraint_unit") = getParam<MultiMooseEnum>("constraint_unit");
116  params.set<Real>("max_ionic_strength") = getParam<Real>("max_ionic_strength");
117  params.set<unsigned>("extra_iterations_to_make_consistent") =
118  getParam<unsigned>("extra_iterations_to_make_consistent");
119  params.set<Real>("stoichiometry_tolerance") = getParam<Real>("stoichiometry_tolerance");
120  params.set<std::string>("charge_balance_species") =
121  getParam<std::string>("charge_balance_species");
122  if (isParamValid("prevent_precipitation"))
123  params.set<std::vector<std::string>>("prevent_precipitation") =
124  getParam<std::vector<std::string>>("prevent_precipitation");
125  params.set<Real>("abs_tol") = getParam<Real>("abs_tol");
126  params.set<Real>("rel_tol") = getParam<Real>("rel_tol");
127  params.set<Real>("min_initial_molality") = getParam<Real>("min_initial_molality");
128  params.set<unsigned>("max_iter") = getParam<unsigned>("max_iter");
129  params.set<Real>("max_initial_residual") = getParam<Real>("max_initial_residual");
130  params.set<Real>("swap_threshold") = getParam<Real>("swap_threshold");
131  params.set<unsigned>("max_swaps_allowed") = getParam<unsigned>("max_swaps_allowed");
132  params.set<unsigned>("ramp_max_ionic_strength_initial") =
133  getParam<unsigned>("ramp_max_ionic_strength_initial");
134  params.set<bool>("ionic_str_using_basis_only") = getParam<bool>("ionic_str_using_basis_only");
135  params.set<bool>("stoichiometric_ionic_str_using_Cl_only") =
136  getParam<bool>("stoichiometric_ionic_str_using_Cl_only");
137  params.set<Real>("temperature") = getParam<Real>("temperature");
138  params.set<ExecFlagEnum>("execute_on") = {EXEC_FINAL};
139  _problem->addUserObject(
140  class_name, getParam<UserObjectName>("geochemistry_reactor_name"), params);
141  }
142 }
MooseApp::setExecutioner
void setExecutioner(std::shared_ptr< Executioner > &&executioner)
MooseMesh
Action::_app
MooseApp & _app
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
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
EXEC_FINAL
const ExecFlagType EXEC_FINAL

◆ 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 AddTimeIndependentReactionSolverAction::validParams ( )
static

Definition at line 28 of file AddTimeIndependentReactionSolverAction.C.

29 {
30  InputParameters params = AddGeochemistrySolverAction::validParams();
31  params.set<ExecFlagEnum>("execute_console_output_on") = EXEC_FINAL;
32  params.set<bool>("solver_info") = true;
33  params.addParam<Real>("temperature", 25.0, "The temperature (degC) of the aqueous solution");
34  params.addClassDescription(
35  "Action that sets up a time-dependent equilibrium reaction solver. This creates creates a "
36  "time-dependent geochemistry solver, and adds AuxVariables corresonding to the molalities, "
37  "etc");
38 
39  return params;
40 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
AddGeochemistrySolverAction::validParams
static InputParameters validParams()
Definition: AddGeochemistrySolverAction.C:25
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:44:33 for https://mooseframework.inl.gov by   doxygen 1.8.14