Action that sets up the geochemical model interrogator. More...

#include <AddGeochemicalModelInterrogatorAction.h>

Inheritance diagram for AddGeochemicalModelInterrogatorAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	AddGeochemicalModelInterrogatorAction (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
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 the geochemical model interrogator.

Definition at line 17 of file AddGeochemicalModelInterrogatorAction.h.

Constructor & Destructor Documentation

◆ AddGeochemicalModelInterrogatorAction()

AddGeochemicalModelInterrogatorAction::AddGeochemicalModelInterrogatorAction ( const InputParameters & parameters )

Definition at line 31 of file AddGeochemicalModelInterrogatorAction.C.

   : Action(params)
 {
 }

Member Function Documentation

◆ act()

void AddGeochemicalModelInterrogatorAction::act ( )

overridevirtual

Implements Action.

Definition at line 38 of file AddGeochemicalModelInterrogatorAction.C.

 {
   // Set up an arbitrary mesh
   if (_current_task == "setup_mesh")
   {
     const std::string class_name = "GeneratedMesh";
     InputParameters params = _factory.getValidParams(class_name);
     params.set<MooseEnum>("dim") = "1";
     _mesh = _factory.create<MooseMesh>(class_name, "mesh", params);
   }
   // Initialize the arbitrary mesh
   else if (_current_task == "init_mesh")
   {
     _mesh->init();
   }
   // Create a "solve=false" FEProblem
   else if (_current_task == "create_problem")
   {
     const std::string class_name = "FEProblem";
     InputParameters params = _factory.getValidParams(class_name);
     params.set<MooseMesh *>("mesh") = _mesh.get();
     params.set<bool>("use_nonlinear") = true;
     params.set<bool>("solve") = false;
     _problem = _factory.create<FEProblemBase>(class_name, "Problem", params);
     _problem->setKernelCoverageCheck(FEProblemBase::CoverageCheckMode::FALSE);
   }
   // Set up an arbitrary steady executioner
   else if (_current_task == "setup_executioner")
   {
     const std::string class_name = "Steady";
     InputParameters params = _factory.getValidParams(class_name);
     params.set<FEProblemBase *>("_fe_problem_base") = _problem.get();
     params.set<FEProblem *>("_fe_problem") = (std::dynamic_pointer_cast<FEProblem>(_problem)).get();
     std::shared_ptr<Executioner> executioner =
         _factory.create<Executioner>(class_name, "Executioner", params);
     _app.setExecutioner(std::move(executioner));
   }
   // Create a console that executes only on FINAL and does not print system info
   else if (_current_task == "add_output")
   {
     const std::string class_name = "GeochemicalModelInterrogator";
     auto params = _factory.getValidParams(class_name);
     params.set<UserObjectName>("model_definition") = getParam<UserObjectName>("model_definition");
     // Only pass parameters that were supplied to this action
     if (isParamValid("swap_out_of_basis"))
       params.set<std::vector<std::string>>("swap_out_of_basis") =
           getParam<std::vector<std::string>>("swap_out_of_basis");
     if (isParamValid("swap_into_basis"))
       params.set<std::vector<std::string>>("swap_into_basis") =
           getParam<std::vector<std::string>>("swap_into_basis");
     if (isParamValid("activity_species"))
       params.set<std::vector<std::string>>("activity_species") =
           getParam<std::vector<std::string>>("activity_species");
     if (isParamValid("activity_values"))
       params.set<std::vector<Real>>("activity_values") =
           getParam<std::vector<Real>>("activity_values");
     params.set<unsigned int>("precision") = getParam<unsigned int>("precision");
     params.set<std::string>("equilibrium_species") = getParam<std::string>("equilibrium_species");
     params.set<MooseEnum>("interrogation") = getParam<MooseEnum>("interrogation");
     params.set<Real>("temperature") = getParam<Real>("temperature");
     params.set<Real>("stoichiometry_tolerance") = getParam<Real>("stoichiometry_tolerance");
     _problem->addOutput(class_name, "geochemical_model_interrogator", params);
   }
 }

◆ validParams()

InputParameters AddGeochemicalModelInterrogatorAction::validParams ( )

static

Definition at line 22 of file AddGeochemicalModelInterrogatorAction.C.

 {
   InputParameters params = Action::validParams();
   params += GeochemicalModelInterrogator::sharedParams();
   params.addClassDescription("Action that sets up the geochemical model interrogator");
 
   return params;
 }

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

geochemistry/include/actions/AddGeochemicalModelInterrogatorAction.h
geochemistry/src/actions/AddGeochemicalModelInterrogatorAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions