A Control object for receiving data from a parent application Sampler object. More...

#include <MultiAppSamplerControl.h>

Inheritance diagram for MultiAppSamplerControl:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	MultiAppSamplerControl (const InputParameters &parameters)

virtual void	initialSetup () override final
	Do not allow the use of initialSetup, because this class is designed to operate on PRE_MULTIAPP_SETUP, which occurs before this callback. More...

virtual void	execute () override

std::vector< std::string > &	getDependencies ()

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

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

bool	isImplicit ()

Moose::StateArg	determineState () const

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

bool	hasFunction (const std::string &param_name) const

bool	hasFunctionByName (const FunctionName &name) const

Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const

const T &	getKokkosFunction (const std::string &name) const

Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const

const T &	getKokkosFunctionByName (const FunctionName &name) const

bool	hasKokkosFunction (const std::string &param_name) const

bool	hasKokkosFunctionByName (const FunctionName &name) const

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObjectBase &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

PerfGraph &	perfGraph ()

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

T &	getSampler (const std::string &name)

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

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)

static MultiMooseEnum	getExecuteOptions ()

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
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

Protected Member Functions
bool	hasControllableParameterByName (const std::string &name) const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

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

virtual void	addUserObjectDependencyHelper (const UserObjectBase &) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

const ReporterName &	getReporterName (const std::string &param_name) const

virtual void	addReporterDependencyHelper (const ReporterName &)

ControllableParameter	getControllableParameter (const std::string &param_name)

ControllableParameter	getControllableParameter (const std::string &param_name)

ControllableParameter	getControllableParameterByName (const std::string &param_name)

ControllableParameter	getControllableParameterByName (const std::string &tag, const std::string &object_name, const std::string &param_name)

ControllableParameter	getControllableParameterByName (const MooseObjectName &object_name, const std::string &param_name)

ControllableParameter	getControllableParameterByName (const MooseObjectParameterName &param_name)

ControllableParameter	getControllableParameterByName (const std::string &param_name)

ControllableParameter	getControllableParameterByName (const std::string &tag, const std::string &object_name, const std::string &param_name)

ControllableParameter	getControllableParameterByName (const MooseObjectName &object_name, const std::string &param_name)

ControllableParameter	getControllableParameterByName (const MooseObjectParameterName &param_name)

T	getControllableValue (const std::string &name, bool warn_when_values_differ=true)

T	getControllableValue (const std::string &name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const MooseObjectParameterName &desired, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const MooseObjectParameterName &desired, bool warn_when_values_differ=true)

void	setControllableValue (const std::string &name, const T &value)

void	setControllableValue (const std::string &name, const T &value)

void	setControllableValueByName (const std::string &name, const T &value)

void	setControllableValueByName (const std::string &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const MooseObjectParameterName &name, const T &value)

void	setControllableValueByName (const std::string &name, const T &value)

void	setControllableValueByName (const std::string &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const MooseObjectParameterName &name, const T &value)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

Protected Attributes
std::shared_ptr< MultiApp >	_multi_app
	The MultiApp this Transfer is transferring data to or from. More...

Sampler &	_sampler
	Sampler to utilize for creating MultiApps. More...

const std::vector< std::string > &	_param_names
	Storage for the parameter names to be applied. More...

std::vector< CLIArgString >	_orig_args
	The original cli_args from input. More...

FEProblemBase &	_fe_problem

std::vector< std::string >	_depends_on

const bool &	_enabled

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 InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_is_transient

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

const Parallel::Communicator &	_communicator

Detailed Description

A Control object for receiving data from a parent application Sampler object.

Definition at line 25 of file MultiAppSamplerControl.h.

Constructor & Destructor Documentation

◆ MultiAppSamplerControl()

MultiAppSamplerControl::MultiAppSamplerControl ( const InputParameters & parameters )

Definition at line 44 of file MultiAppSamplerControl.C.

   : Control(parameters),
     SamplerInterface(this),
     _multi_app(_fe_problem.getMultiApp(getParam<MultiAppName>("multi_app"))),
     _sampler(SamplerInterface::getSampler("sampler")),
     _param_names(getParam<std::vector<std::string>>("param_names"))
 {
   if (!_sampler.getParam<ExecFlagEnum>("execute_on").isValueSet(EXEC_PRE_MULTIAPP_SETUP))
     _sampler.paramError(
         "execute_on",
         "The sampler object, '",
         _sampler.name(),
         "', is being used by the '",
         name(),
         "' object, thus the 'execute_on' of the sampler must include 'PRE_MULTIAPP_SETUP'.");
 
   if (_multi_app->usingPositions())
     paramError("multi_app",
                "The MultiApp must construct its sub-apps in initial setup but not during its "
                "creation for '",
                type(),
                "'.\nTypically only sampler MultiApps work with '",
                type(),
                "' objects.");
 
   bool batch_reset = _multi_app->isParamValid("mode") &&
                      (_multi_app->getParam<MooseEnum>("mode") == "batch-reset");
   bool batch_restore = _multi_app->isParamValid("mode") &&
                        (_multi_app->getParam<MooseEnum>("mode") == "batch-restore");
   if (batch_reset)
     ; // Do not perform the App count test, because in batch mode there is only one
 
   else if (batch_restore)
     _multi_app->paramError(
         "mode",
         "The MultiApp object, '",
         _multi_app->name(),
         "', supplied to the '",
         name(),
         "' object is setup to run in 'batch-restore' mode, when using this mode command line "
         "arguments cannot be modified; batch-reset mode should be used instead.");
 
   else if (_multi_app->numGlobalApps() != _sampler.getNumberOfRows())
     mooseError("The number of sub apps (",
                _multi_app->numGlobalApps(),
                ") created by MultiApp object '",
                _multi_app->name(),
                "' must be equal to the number for rows (",
                _sampler.getNumberOfRows(),
                ") for the '",
                _sampler.name(),
                "' Sampler object.");
 }

Member Function Documentation

◆ execute()

void MultiAppSamplerControl::execute ( )

overridevirtual

Implements Control.

Definition at line 106 of file MultiAppSamplerControl.C.

 {
   // Gather the original arguments given in the parameter so we can keep them
   if (_orig_args.empty())
   {
     _orig_args = getControllableValueByName<std::vector<CLIArgString>>(
         "MultiApp", _multi_app->name(), "cli_args", true);
     if (_orig_args.size() == 0)
       _orig_args.push_back("");
     else if (_param_names.size())
       for (auto & clia : _orig_args)
         clia += ";";
   }
 
   auto cli_args = _orig_args;
 
   // To avoid storing duplicated param_names for each sampler, we store only param_names once in
   // "cli_args".
 
   // Handle a couple errors up front regarding bracket expressions
   bool has_brackets = false;
   if (_param_names.size())
   {
     has_brackets = _param_names[0].find("[") != std::string::npos;
     for (unsigned int i = 1; i < _param_names.size(); ++i)
       if (has_brackets != (_param_names[i].find("[") != std::string::npos))
         paramError("param_names",
                    "If the bracket is used, it must be provided to every parameter.");
   }
   if (!has_brackets && _sampler.getNumberOfCols() != _param_names.size())
     paramError("param_names",
                "The number of columns (",
                _sampler.getNumberOfCols(),
                ") must match the number of parameters (",
                _param_names.size(),
                ").");
 
   // Add the parameters that will be modified. The MultiApp will ultimately be
   // responsible for assigning the values from the sampler.
   std::ostringstream oss;
   for (dof_id_type col = 0; col < _param_names.size(); ++col)
   {
     if (col > 0)
       oss << ";";
     oss << _param_names[col];
   }
 
   // Put all the parameters in a single string
   for (auto & clia : cli_args)
     clia += oss.str();
 
   setControllableValueByName<std::vector<CLIArgString>>(
       "MultiApp", _multi_app->name(), "cli_args", cli_args);
 }

◆ initialSetup()

void MultiAppSamplerControl::initialSetup ( )

finaloverridevirtual

Do not allow the use of initialSetup, because this class is designed to operate on PRE_MULTIAPP_SETUP, which occurs before this callback.

This will prevent a child class adding something to this function without it doing anything.

Reimplemented from Control.

Definition at line 99 of file MultiAppSamplerControl.C.

 {
   // Do not put anything here, this method is being called after execute because the execute_on
   // is set to PRE_MULTIAPP_SETUP for this class. It won't work any other way.
 }

◆ validParams()

InputParameters MultiAppSamplerControl::validParams ( )

static

Definition at line 24 of file MultiAppSamplerControl.C.

 {
   InputParameters params = Control::validParams();
   params += SamplerInterface::validParams();
   params.addClassDescription("Control for modifying the command line arguments of MultiApps.");
 
   // Set and suppress the 'execute_on' flag, it doesn't work with any other flag
   params.set<ExecFlagEnum>("execute_on") = {EXEC_PRE_MULTIAPP_SETUP};
   params.suppressParameter<ExecFlagEnum>("execute_on");
 
   params.addRequiredParam<MultiAppName>("multi_app", "The name of the MultiApp to control.");
   params.addRequiredParam<SamplerName>(
       "sampler",
       "The Sampler object to utilize for altering the command line options of the MultiApp.");
   params.addRequiredParam<std::vector<std::string>>(
       "param_names", "The names of the command line parameters to set via the sampled data.");
 
   return params;
 }

Member Data Documentation

◆ _multi_app

std::shared_ptr<MultiApp> MultiAppSamplerControl::_multi_app

protected

The MultiApp this Transfer is transferring data to or from.

Definition at line 43 of file MultiAppSamplerControl.h.

Referenced by execute(), and MultiAppSamplerControl().

◆ _orig_args

std::vector<CLIArgString> MultiAppSamplerControl::_orig_args

protected

The original cli_args from input.

Definition at line 52 of file MultiAppSamplerControl.h.

Referenced by execute().

◆ _param_names

const std::vector<std::string>& MultiAppSamplerControl::_param_names

protected

Storage for the parameter names to be applied.

Definition at line 49 of file MultiAppSamplerControl.h.

Referenced by execute().

◆ _sampler

Sampler& MultiAppSamplerControl::_sampler

protected

Sampler to utilize for creating MultiApps.

Definition at line 46 of file MultiAppSamplerControl.h.

Referenced by execute(), and MultiAppSamplerControl().

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

stochastic_tools/include/controls/MultiAppSamplerControl.h
stochastic_tools/src/controls/MultiAppSamplerControl.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MultiAppSamplerControl()

Member Function Documentation

◆ execute()

◆ initialSetup()

◆ validParams()

Member Data Documentation

◆ _multi_app

◆ _orig_args

◆ _param_names

◆ _sampler