Helper for performing common tasks for stochastic simulations. More...

#include <StochasticToolsAction.h>

Inheritance diagram for StochasticToolsAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	StochasticToolsAction (const InputParameters &params)

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

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () 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 &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (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

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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 ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) 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

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

Detailed Description

Helper for performing common tasks for stochastic simulations.

Setup Mesh, Problem, Executioner for runner only problems

Definition at line 19 of file StochasticToolsAction.h.

Constructor & Destructor Documentation

◆ StochasticToolsAction()

StochasticToolsAction::StochasticToolsAction ( const InputParameters & params )

Definition at line 42 of file StochasticToolsAction.C.

42: Action(params) {}

Action

Member Function Documentation

◆ act()

void StochasticToolsAction::act ( )

overridevirtual

Implements Action.

Definition at line 45 of file StochasticToolsAction.C.

{
  // [Mesh]
  if (_current_task == "auto_create_mesh" && getParam<bool>("auto_create_mesh") &&
      !_awh.hasActions("setup_mesh"))
  {
    // Build the Action parameters
    InputParameters action_params = _action_factory.getValidParams("SetupMeshAction");
    action_params.set<std::string>("type") = "GeneratedMesh";
 
    // Associate errors with "auto_create_mesh"
    associateWithParameter("auto_create_mesh", action_params);
 
    // Create The Action
    auto action = std::static_pointer_cast<MooseObjectAction>(
        _action_factory.create("SetupMeshAction", "Mesh", action_params));
 
    // Set the object parameters
    InputParameters & params = action->getObjectParams();
    params.set<MooseEnum>("dim") = "1";
    params.set<unsigned int>("nx") = 1;
 
    // Add Action to the warehouse
    _awh.addActionBlock(action);
  }
 
  // [Problem]
  else if (_current_task == "auto_create_problem" && getParam<bool>("auto_create_problem"))
  {
    if (_awh.hasActions("create_problem"))
    {
      for (const auto & act : _awh.getActionListByName("create_problem"))
      {
        auto * action = dynamic_cast<CreateProblemAction *>(act);
        if (action)
        {
          InputParameters & params = action->getObjectParams();
 
          if (!params.isParamSetByUser("solve"))
            params.set<bool>("solve") = false;
 
          if (!params.isParamSetByUser("kernel_coverage_check"))
            params.set<MooseEnum>("kernel_coverage_check") = "false";
 
          if (!params.isParamSetByUser("skip_nl_system_check"))
            params.set<bool>("skip_nl_system_check") = true;
        }
      }
    }
    else
    {
      // Build the Action parameters
      InputParameters action_params = _action_factory.getValidParams("CreateProblemAction");
 
      // Associate errors with "auto_create_problem"
      associateWithParameter("auto_create_problem", action_params);
 
      // Create the action
      auto action = std::static_pointer_cast<MooseObjectAction>(
          _action_factory.create("CreateProblemAction", "Problem", action_params));
 
      // Set the object parameters
      InputParameters & params = action->getObjectParams();
      params.set<bool>("solve") = false;
      params.set<MooseEnum>("kernel_coverage_check") = "false";
      params.set<bool>("skip_nl_system_check") = true;
 
      // Add Action to the warehouse
      _awh.addActionBlock(action);
    }
  }
 
  // [Executioner]
  else if (_current_task == "auto_create_executioner" &&
           getParam<bool>("auto_create_executioner") && !_awh.hasActions("setup_executioner"))
  {
    // Build the Action parameters
    InputParameters action_params = _action_factory.getValidParams("CreateExecutionerAction");
    action_params.set<std::string>("type") = "Steady";
 
    // Associate errors with "auto_create_executioner"
    associateWithParameter("auto_create_executioner", action_params);
 
    // Create the action
    auto action = std::static_pointer_cast<MooseObjectAction>(
        _action_factory.create("CreateExecutionerAction", "Executioner", action_params));
 
    // Add Action to the warehouse
    _awh.addActionBlock(action);
  }
}

Referenced by act().

◆ validParams()

InputParameters StochasticToolsAction::validParams ( )

static

Definition at line 22 of file StochasticToolsAction.C.

{
  InputParameters params = Action::validParams();
  params.addClassDescription(
      "Action for performing some common functions for running stochastic simulations.");
  params.addParam<bool>(
      "auto_create_mesh",
      true,
      "Automatically setup the Mesh block for a master application without a simulation.");
  params.addParam<bool>(
      "auto_create_problem",
      true,
      "Automatically setup the Problem block for a master application without a simulation.");
  params.addParam<bool>(
      "auto_create_executioner",
      true,
      "Automatically setup the Executioner block for a master application without a simulation.");
  return params;
}

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

stochastic_tools/include/actions/StochasticToolsAction.h
stochastic_tools/src/actions/StochasticToolsAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions