#include <AdaptiveSamplerAction.h>

Inheritance diagram for AdaptiveSamplerAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	AdaptiveSamplerAction (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

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 ()

static std::set< SamplerName >	adaptiveSamplerNames ()
	Returns the names of all the existing adaptive samplers. More...

static PostprocessorName	adaptiveSamplingCompletedPostprocessorName ()
	Returns the name of the AdaptiveSamplingCompletedPostprocessor. More...

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

Definition at line 14 of file AdaptiveSamplerAction.h.

Constructor & Destructor Documentation

◆ AdaptiveSamplerAction()

AdaptiveSamplerAction::AdaptiveSamplerAction ( const InputParameters & params )

Definition at line 25 of file AdaptiveSamplerAction.C.

25 : Action(params) {}

Action::Action

Action(const InputParameters &parameters)

Member Function Documentation

◆ act()

void AdaptiveSamplerAction::act ( )

overridevirtual

Implements Action.

Definition at line 28 of file AdaptiveSamplerAction.C.

 {
   const auto samplers = _app.actionWarehouse().getActions<AddSamplerAction>();
   SamplerName sampler_name;
 
   // determine whether the sampler is an adaptive sampler
   for (auto & sampler : samplers)
     if (adaptiveSamplerNames().count(sampler->getMooseObjectType()) > 0)
     {
       if (!sampler_name.empty())
         mooseError("The case with multiple adaptive samplers is not currently supported");
       sampler_name = sampler->name();
     }
 
   if (sampler_name.empty())
     return;
 
   if (_current_task == "add_user_object")
   {
     InputParameters params = _factory.getValidParams("Terminator");
     params.set<std::string>("expression") = adaptiveSamplingCompletedPostprocessorName() + " > 0";
     params.set<std::string>("message") = "Sampling completed!";
     params.set<ExecFlagEnum>("execute_on") = {EXEC_TIMESTEP_END};
     _problem->addUserObject("Terminator", "_terminate" + sampler_name, params);
   }
   else if (_current_task == "add_postprocessor")
   {
     InputParameters params = _factory.getValidParams("AdaptiveSamplingCompletedPostprocessor");
     params.set<SamplerName>("sampler") = sampler_name;
     params.set<ExecFlagEnum>("execute_on") = {EXEC_TIMESTEP_END};
     params.set<std::vector<OutputName>>("outputs") = {"none"};
     _problem->addUserObject("AdaptiveSamplingCompletedPostprocessor",
                             adaptiveSamplingCompletedPostprocessorName(),
                             params);
   }
 }

◆ adaptiveSamplerNames()

static std::set<SamplerName> AdaptiveSamplerAction::adaptiveSamplerNames ( )

inlinestatic

Returns the names of all the existing adaptive samplers.

Definition at line 24 of file AdaptiveSamplerAction.h.

Referenced by act().

   {
     return {"ParallelSubsetSimulation",
             "AdaptiveImportance",
             "AISActiveLearning",
             "ActiveLearningMonteCarloSampler"};
   }

◆ adaptiveSamplingCompletedPostprocessorName()

static PostprocessorName AdaptiveSamplerAction::adaptiveSamplingCompletedPostprocessorName ( )

inlinestatic

Returns the name of the AdaptiveSamplingCompletedPostprocessor.

Definition at line 35 of file AdaptiveSamplerAction.h.

Referenced by act().

   {
     return "_sampling_completed_pp";
   }

◆ validParams()

InputParameters AdaptiveSamplerAction::validParams ( )

static

Definition at line 18 of file AdaptiveSamplerAction.C.

 {
   InputParameters params = Action::validParams();
   params.addClassDescription("Adds extra objects pertaining to adaptive samplers.");
   return params;
 }

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes