Transfer Reporters from sub-applications to a StochasticReporter on the main application. More...

#include <SamplerReporterTransfer.h>

Inheritance diagram for SamplerReporterTransfer:

Public Types
enum	DIRECTION

typedef DataFileName	DataFileParameterType

Public Member Functions
	SamplerReporterTransfer (const InputParameters &parameters)

virtual void	initialSetup () override

void	setGlobalMultiAppIndex (dof_id_type index)
	Method for setting the app index when running in batch mode. More...

void	setGlobalRowIndex (dof_id_type row)
	Method for keeping track of the global row index when running in batch mode. More...

void	setCurrentRow (const std::vector< Real > &row)
	Method for keeping track of the row data when running in batch mode. More...

void	variableIntegrityCheck (const AuxVariableName &var_name, bool is_from_multiapp) const

const std::shared_ptr< MultiApp >	getMultiApp () const

const std::shared_ptr< MultiApp >	getFromMultiApp () const

const std::shared_ptr< MultiApp >	getToMultiApp () const

std::string	getFromName () const

std::string	getToName () const

bool	hasFromMultiApp () const

bool	hasToMultiApp () const

virtual void	getAppInfo ()

const MultiMooseEnum &	directions ()

void	setCurrentDirection (const int direction)

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

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

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

PerfGraph &	perfGraph ()

MooseEnum	direction ()

MooseEnum	direction ()

MooseEnum	currentDirection ()

MooseEnum	currentDirection ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const


virtual void	initializeToMultiapp ()
	Methods for transferring data to sub-applications to the master application. More...

virtual void	executeToMultiapp ()

virtual void	finalizeToMultiapp ()

Static Public Member Functions
static InputParameters	validParams ()

static void	addSkipCoordCollapsingParam (InputParameters &params)

static libMesh::System *	find_sys (libMesh::EquationSystems &es, const std::string &var_name)

static std::string	possibleDirections ()

Public Attributes
	TO_MULTIAPP

	FROM_MULTIAPP

	BETWEEN_MULTIAPP

const ConsoleStream	_console

Static Public Attributes
static const libMesh::Number	OutOfMeshValue

Protected Member Functions
virtual void	execute () override
	Traditional Transfer callback. More...

void	intitializeStochasticReporters ()
	Used to declare reporter values on main app and add consumer modes on subapps. More...

void	transferStochasticReporters (dof_id_type global_index, dof_id_type app_index)
	Transfer reporter values. More...

std::vector< unsigned int >	getFromsPerProc ()

libMesh::NumericVector< Real > &	getTransferVector (unsigned int i_local, std::string var_name)

unsigned int	getGlobalSourceAppIndex (unsigned int i_from) const

unsigned int	getGlobalTargetAppIndex (unsigned int i_to) const

unsigned int	getLocalSourceAppIndex (unsigned int i_from) const

virtual void	checkSiblingsTransferSupported () const

void	errorIfObjectExecutesOnTransferInSourceApp (const std::string &object_name) const

Point	getPointInTargetAppFrame (const Point &p, unsigned int local_i_to, const std::string &phase) const

void	checkMultiAppExecuteOn ()

void	checkVariable (const FEProblemBase &fe_problem, const VariableName &var_name, const std::string &param_name="") const

void	extendBoundingBoxes (const Real factor, std::vector< libMesh::BoundingBox > &bboxes) 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

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

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes ()

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes (BoundaryID boundary_id)

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes ()

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes (BoundaryID boundary_id)

void	addReporterTransferMode (const ReporterName &name, const ReporterMode &mode, FEProblemBase &problem)

void	transferReporter (const ReporterName &from_reporter, const ReporterName &to_reporter, const FEProblemBase &from_problem, FEProblemBase &to_problem, unsigned int time_index=0)

void	transferToVectorReporter (const ReporterName &from_reporter, const ReporterName &to_reporter, const FEProblemBase &from_problem, FEProblemBase &to_problem, dof_id_type index, unsigned int time_index=0)

void	transferFromVectorReporter (const ReporterName &from_reporter, const ReporterName &to_reporter, const FEProblemBase &from_problem, FEProblemBase &to_problem, dof_id_type index, unsigned int time_index=0)

void	declareClone (const ReporterName &from_reporter, const ReporterName &to_reporter, const FEProblemBase &from_problem, FEProblemBase &to_problem, const ReporterMode &mode)

void	declareClone (const ReporterName &rname, FEProblemBase &problem, const std::string &type, const ReporterMode &mode)

void	declareVectorClone (const ReporterName &from_reporter, const ReporterName &to_reporter, const FEProblemBase &from_problem, FEProblemBase &to_problem, const ReporterMode &mode)

void	declareVectorClone (const ReporterName &rname, FEProblemBase &problem, const std::string &type, const ReporterMode &mode)

void	resizeReporter (const ReporterName &name, FEProblemBase &problem, dof_id_type n)

void	clearVectorReporter (const ReporterName &name, FEProblemBase &problem)

void	sumVectorReporter (const ReporterName &name, FEProblemBase &problem)

std::vector< ReporterName >	getReporterNamesHelper (std::string prefix, const std::string &obj_name, const std::vector< ReporterName > &rep_names)

void	checkHasReporterValue (const ReporterName &reporter, const FEProblemBase &problem) const


virtual void	initializeFromMultiapp () override
	Methods used when running in batch mode (see SamplerFullSolveMultiApp) More...

virtual void	executeFromMultiapp () override

virtual void	finalizeFromMultiapp () override

Static Protected Member Functions
static void	addBBoxFactorParam (InputParameters &params)

static void	transformBoundingBox (libMesh::BoundingBox &box, const MultiAppCoordTransform &transform)

static MultiMooseEnum	standardTransferTypes ()

Protected Attributes
const std::vector< ReporterName > &	_sub_reporter_names
	Name of reporters on the sub-applications. More...

StochasticReporter *	_results = nullptr
	StochasticReporter object where values are being transferred. More...

std::vector< ReporterName >	_reporter_names
	Storage vector names. More...

std::vector< bool > *	_converged
	Reporter value for whether or not sub app converged. More...

dof_id_type	_app_index = 0
	Index for the sub-app that the batch-mode multiapp is working on. More...

dof_id_type	_global_index = 0
	Index for tracking the row index when using batch mode operation. More...

std::vector< Real >	_row_data
	The current row of data (comes from multiapp) More...

Sampler *	_sampler_ptr
	Pointer to the Sampler object used by the SamplerTransientMultiApp or SamplerFullSolveMultiApp. More...

std::shared_ptr< MultiApp >	_multi_app

std::vector< FEProblemBase *>	_to_problems

std::vector< FEProblemBase *>	_from_problems

std::vector< libMesh::EquationSystems *>	_to_es

std::vector< libMesh::EquationSystems *>	_from_es

std::vector< MooseMesh *>	_to_meshes

std::vector< MooseMesh *>	_from_meshes

std::vector< Point >	_to_positions

std::vector< Point >	_from_positions

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_to_transforms

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_from_transforms

const bool	_skip_coordinate_collapsing

bool	_displaced_source_mesh

bool	_displaced_target_mesh

Real	_bbox_factor

std::vector< unsigned int >	_to_local2global_map

std::vector< unsigned int >	_from_local2global_map

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

MultiMooseEnum	_directions

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

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

MooseApp &	_pg_moose_app

const std::string	_prefix

MooseEnum	_direction

MooseEnum	_current_direction

const Parallel::Communicator &	_communicator

Detailed Description

Transfer Reporters from sub-applications to a StochasticReporter on the main application.

This object transfers the distributed data to a StochasticReporter object.

Definition at line 24 of file SamplerReporterTransfer.h.

Constructor & Destructor Documentation

◆ SamplerReporterTransfer()

SamplerReporterTransfer::SamplerReporterTransfer ( const InputParameters & parameters )

Definition at line 43 of file SamplerReporterTransfer.C.

   : StochasticToolsTransfer(parameters),
     ReporterTransferInterface(this),
     _sub_reporter_names(getParam<std::vector<ReporterName>>("from_reporter"))
 {
   if (hasToMultiApp())
     paramError("to_multi_app", "To and between multiapp directions are not implemented");
 }

Member Function Documentation

◆ execute()

void SamplerReporterTransfer::execute ( )

overrideprotectedvirtual

Traditional Transfer callback.

Implements MultiAppTransfer.

Definition at line 86 of file SamplerReporterTransfer.C.

 {
   for (dof_id_type i = _sampler_ptr->getLocalRowBegin(); i < _sampler_ptr->getLocalRowEnd(); ++i)
     transferStochasticReporters(i, i);
 }

◆ executeFromMultiapp()

void SamplerReporterTransfer::executeFromMultiapp ( )

overrideprotectedvirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 70 of file SamplerReporterTransfer.C.

 {
   if (getFromMultiApp()->isRootProcessor())
   {
     const dof_id_type n = getFromMultiApp()->numGlobalApps();
     for (MooseIndex(n) i = 0; i < n; i++)
       transferStochasticReporters(_global_index, i);
   }
 }

◆ executeToMultiapp()

void StochasticToolsTransfer::executeToMultiapp ( )

virtualinherited

Reimplemented in SerializedSolutionTransfer, PODSamplerSolutionTransfer, and SamplerParameterTransfer.

Definition at line 131 of file StochasticToolsTransfer.C.

132 {

133 }

◆ finalizeFromMultiapp()

void SamplerReporterTransfer::finalizeFromMultiapp ( )

overrideprotectedvirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 81 of file SamplerReporterTransfer.C.

82 {

83 }

◆ finalizeToMultiapp()

void StochasticToolsTransfer::finalizeToMultiapp ( )

virtualinherited

Reimplemented in SerializedSolutionTransfer, and PODSamplerSolutionTransfer.

Definition at line 136 of file StochasticToolsTransfer.C.

137 {

138 }

◆ initializeFromMultiapp()

void SamplerReporterTransfer::initializeFromMultiapp ( )

overrideprotectedvirtual

Methods used when running in batch mode (see SamplerFullSolveMultiApp)

Reimplemented from StochasticToolsTransfer.

Definition at line 65 of file SamplerReporterTransfer.C.

66 {

67 }

◆ initializeToMultiapp()

void StochasticToolsTransfer::initializeToMultiapp ( )

virtualinherited

Methods for transferring data to sub-applications to the master application.

Reimplemented in SerializedSolutionTransfer, and PODSamplerSolutionTransfer.

Definition at line 126 of file StochasticToolsTransfer.C.

127 {

128 }

◆ initialSetup()

void SamplerReporterTransfer::initialSetup ( )

overridevirtual

Reimplemented from MultiAppTransfer.

Definition at line 53 of file SamplerReporterTransfer.C.

 {
   // Get the StochasticResults VPP object to populate
   auto & uo = _fe_problem.getUserObject<UserObject>(getParam<std::string>("stochastic_reporter"));
   _results = dynamic_cast<StochasticReporter *>(&uo);
   if (!_results)
     paramError("stochastic_reporter", "This object must be a 'StochasticReporter' object.");
 
   intitializeStochasticReporters();
 }

◆ intitializeStochasticReporters()

void SamplerReporterTransfer::intitializeStochasticReporters ( )

protected

Used to declare reporter values on main app and add consumer modes on subapps.

Definition at line 93 of file SamplerReporterTransfer.C.

Referenced by initialSetup().

 {
   const dof_id_type n = getFromMultiApp()->numGlobalApps();
 
   for (const auto & sub_rname : _sub_reporter_names)
     for (MooseIndex(n) i = 0; i < n; i++)
       if (getFromMultiApp()->hasLocalApp(i))
         addReporterTransferMode(
             sub_rname, REPORTER_MODE_ROOT, getFromMultiApp()->appProblemBase(i));
 
   const std::string prefix = isParamValid("prefix") ? getParam<std::string>("prefix") : name();
   for (const auto & sub_rname : _sub_reporter_names)
     for (MooseIndex(n) i = 0; i < n; i++)
       if (getFromMultiApp()->hasLocalApp(i))
       {
         const ReporterData & rdata = getFromMultiApp()->appProblemBase(i).getReporterData();
         ReporterName rname =
             _results->declareStochasticReporterClone(*_sampler_ptr, rdata, sub_rname, prefix);
         if (rname.empty())
           paramError("from_reporter",
                      "Reporter value ",
                      sub_rname,
                      " is of unsupported type ",
                      rdata.getReporterContextBase(sub_rname).type(),
                      ". Contact MOOSE developers on how to transfer this type of reporter value.");
         _reporter_names.push_back(rname);
         break;
       }
 
   _converged = &_results->declareStochasticReporter<bool>(
       prefix + (prefix.empty() ? "" : ":") + "converged", *_sampler_ptr);
 }

◆ setCurrentRow()

void StochasticToolsTransfer::setCurrentRow ( const std::vector< Real > & row )

inlineinherited

Method for keeping track of the row data when running in batch mode.

See StochasticTools<FullSolve/Transient>MultiApp

Definition at line 65 of file StochasticToolsTransfer.h.

65 { _row_data = row; }

StochasticToolsTransfer::_row_data

std::vector< Real > _row_data

The current row of data (comes from multiapp)

Definition: StochasticToolsTransfer.h:73

◆ setGlobalMultiAppIndex()

void StochasticToolsTransfer::setGlobalMultiAppIndex ( dof_id_type index )

inlineinherited

Method for setting the app index when running in batch mode.

See StochasticTools<FullSolve/Transient>MultiApp

Definition at line 51 of file StochasticToolsTransfer.h.

51 { _app_index = index; }

StochasticToolsTransfer::_app_index

dof_id_type _app_index

Index for the sub-app that the batch-mode multiapp is working on.

Definition: StochasticToolsTransfer.h:69

◆ setGlobalRowIndex()

void StochasticToolsTransfer::setGlobalRowIndex ( dof_id_type row )

inlineinherited

Method for keeping track of the global row index when running in batch mode.

See StochasticTools<FullSolve/Transient>MultiApp

Definition at line 58 of file StochasticToolsTransfer.h.

58 { _global_index = row; }

StochasticToolsTransfer::_global_index

dof_id_type _global_index

Index for tracking the row index when using batch mode operation.

Definition: StochasticToolsTransfer.h:71

◆ transferStochasticReporters()

void SamplerReporterTransfer::transferStochasticReporters	(	dof_id_type	global_index,
		dof_id_type	app_index
	)

protected

Transfer reporter values.

Parameters

global_index	The global row of the sampler matrix
app_index	The subapp index to transfer from

Definition at line 127 of file SamplerReporterTransfer.C.

Referenced by execute(), and executeFromMultiapp().

 {
   if (getFromMultiApp()->hasLocalApp(app_index))
   {
     const dof_id_type local_index = global_index - _sampler_ptr->getLocalRowBegin();
     for (unsigned int r = 0; r < _sub_reporter_names.size(); ++r)
       transferToVectorReporter(_sub_reporter_names[r],
                                _reporter_names[r],
                                getFromMultiApp()->appProblemBase(app_index),
                                getFromMultiApp()->problemBase(),
                                local_index);
 
     (*_converged)[local_index] = getFromMultiApp()->getExecutioner(app_index)->lastSolveConverged();
   }
 }

◆ validParams()

InputParameters SamplerReporterTransfer::validParams ( )

static

Definition at line 23 of file SamplerReporterTransfer.C.

 {
   InputParameters params = StochasticToolsTransfer::validParams();
   params.addClassDescription("Transfers data from Reporters on the sub-application to a "
                              "StochasticReporter on the main application.");
 
   params.addRequiredParam<std::vector<ReporterName>>(
       "from_reporter", "The name(s) of the Reporter(s) on the sub-app to transfer from.");
   params.addRequiredParam<std::string>(
       "stochastic_reporter", "The name of the StochasticReporter object to transfer values to.");
 
   params.addParam<std::string>("prefix",
                                "Use the supplied string as the prefix for reporter "
                                "name rather than the transfer name.");
 
   params.suppressParameter<MultiMooseEnum>("direction");
   params.suppressParameter<MultiAppName>("multi_app");
   return params;
 }

Member Data Documentation

◆ _app_index

dof_id_type StochasticToolsTransfer::_app_index = 0

protectedinherited

Index for the sub-app that the batch-mode multiapp is working on.

Definition at line 69 of file StochasticToolsTransfer.h.

Referenced by SerializedSolutionTransfer::executeFromMultiapp(), SamplerParameterTransfer::executeToMultiapp(), SerializedSolutionTransfer::initializeInBatchMode(), and StochasticToolsTransfer::setGlobalMultiAppIndex().

◆ _converged

std::vector<bool>* SamplerReporterTransfer::_converged

protected

Reporter value for whether or not sub app converged.

Definition at line 68 of file SamplerReporterTransfer.h.

Referenced by intitializeStochasticReporters().

◆ _global_index

dof_id_type StochasticToolsTransfer::_global_index = 0

protectedinherited

Index for tracking the row index when using batch mode operation.

Definition at line 71 of file StochasticToolsTransfer.h.

Referenced by PODResidualTransfer::executeFromMultiapp(), PODSamplerSolutionTransfer::executeFromMultiapp(), SerializedSolutionTransfer::executeFromMultiapp(), executeFromMultiapp(), PODSamplerSolutionTransfer::executeToMultiapp(), and StochasticToolsTransfer::setGlobalRowIndex().

◆ _reporter_names

std::vector<ReporterName> SamplerReporterTransfer::_reporter_names

protected

Storage vector names.

Definition at line 65 of file SamplerReporterTransfer.h.

Referenced by intitializeStochasticReporters(), and transferStochasticReporters().

◆ _results

StochasticReporter* SamplerReporterTransfer::_results = nullptr

protected

StochasticReporter object where values are being transferred.

Definition at line 62 of file SamplerReporterTransfer.h.

Referenced by initialSetup(), and intitializeStochasticReporters().

◆ _row_data

std::vector<Real> StochasticToolsTransfer::_row_data

protectedinherited

The current row of data (comes from multiapp)

Definition at line 73 of file StochasticToolsTransfer.h.

Referenced by SamplerParameterTransfer::executeToMultiapp(), and StochasticToolsTransfer::setCurrentRow().

◆ _sampler_ptr

Sampler* StochasticToolsTransfer::_sampler_ptr

protectedinherited

Pointer to the Sampler object used by the SamplerTransientMultiApp or SamplerFullSolveMultiApp.

Definition at line 76 of file StochasticToolsTransfer.h.

Referenced by SamplerParameterTransfer::execute(), PODSamplerSolutionTransfer::execute(), SerializedSolutionTransfer::execute(), execute(), SamplerPostprocessorTransfer::execute(), SamplerPostprocessorTransfer::initializeFromMultiapp(), intitializeStochasticReporters(), StochasticToolsTransfer::StochasticToolsTransfer(), SerializedSolutionTransfer::transferInParallel(), and transferStochasticReporters().

◆ _sub_reporter_names

const std::vector<ReporterName>& SamplerReporterTransfer::_sub_reporter_names

protected

Name of reporters on the sub-applications.

Definition at line 59 of file SamplerReporterTransfer.h.

Referenced by intitializeStochasticReporters(), and transferStochasticReporters().

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

stochastic_tools/include/transfers/SamplerReporterTransfer.h
stochastic_tools/src/transfers/SamplerReporterTransfer.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SamplerReporterTransfer()

Member Function Documentation

◆ execute()

◆ executeFromMultiapp()

◆ executeToMultiapp()

◆ finalizeFromMultiapp()

◆ finalizeToMultiapp()

◆ initializeFromMultiapp()

◆ initializeToMultiapp()

◆ initialSetup()

◆ intitializeStochasticReporters()

◆ setCurrentRow()

◆ setGlobalMultiAppIndex()

◆ setGlobalRowIndex()

◆ transferStochasticReporters()

◆ validParams()

Member Data Documentation

◆ _app_index

◆ _converged

◆ _global_index

◆ _reporter_names

◆ _results

◆ _row_data

◆ _sampler_ptr

◆ _sub_reporter_names