Copy each row from each DenseMatrix to the sub-applications SamplerReceiver object. More...

#include <SamplerParameterTransfer.h>

Inheritance diagram for SamplerParameterTransfer:

Public Types
enum	DIRECTION

typedef DataFileName	DataFileParameterType

Public Member Functions
	SamplerParameterTransfer (const InputParameters &parameters)

virtual void	execute () override
	Traditional Transfer callback. More...

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

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

void	initialSetup () override

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	initializeFromMultiapp ()
	Methods for transferring data from sub-applications to the master application. More...

virtual void	executeFromMultiapp ()

virtual void	finalizeFromMultiapp ()


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

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
std::map< SamplerReceiver *, std::map< std::string, std::vector< Real > > >	getReceivers (unsigned int app_index, const std::vector< std::string > &args)
	Based on command line args, return a map between SamplerReceiver objects and the parameter-value pairs. 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)

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

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

Protected Attributes
const std::vector< std::string > &	_parameter_names
	Storage for the list of parameters to control. More...

dof_id_type	_global_index
	Current global index for batch execution. More...

dof_id_type	_app_index = 0
	Index for the sub-app that the batch-mode multiapp is working on. 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

Static Private Member Functions
static std::vector< FEProblemBase * >	getMultiAppProblemsHelper (FEProblemBase &base_problem, const std::vector< std::string > &multiapp_names)
	Helper function that recursively finds feproblem pointers from nested multiapps. More...

Detailed Description

Copy each row from each DenseMatrix to the sub-applications SamplerReceiver object.

Definition at line 21 of file SamplerParameterTransfer.h.

Constructor & Destructor Documentation

◆ SamplerParameterTransfer()

SamplerParameterTransfer::SamplerParameterTransfer ( const InputParameters & parameters )

Definition at line 44 of file SamplerParameterTransfer.C.

   : StochasticToolsTransfer(parameters),
     _parameter_names(getParam<std::vector<std::string>>("parameters"))
 {
   if (hasFromMultiApp())
     paramError("from_multi_app", "From and between multiapp directions are not implemented");
 }

Member Function Documentation

◆ execute()

void SamplerParameterTransfer::execute ( )

overridevirtual

Traditional Transfer callback.

Implements MultiAppTransfer.

Definition at line 53 of file SamplerParameterTransfer.C.

 {
   mooseAssert((_sampler_ptr->getNumberOfLocalRows() == 0) ||
                   (_sampler_ptr->getNumberOfLocalRows() == getToMultiApp()->numLocalApps()),
               "The number of MultiApps and the number of sample rows must be the same.");
 
   // Loop over all sub-apps
   for (dof_id_type row_index = _sampler_ptr->getLocalRowBegin();
        row_index < _sampler_ptr->getLocalRowEnd();
        row_index++)
   {
     mooseAssert(getToMultiApp()->hasLocalApp(row_index),
                 "The current sample row index is not a valid global MultiApp index.");
 
     // Populate the row of data to transfer
     std::vector<Real> row = _sampler_ptr->getNextLocalRow();
 
     // Get the command line arguments
     const auto args = SamplerFullSolveMultiApp::sampledCommandLineArgs(row, _parameter_names);
 
     // Get the sub-app SamplerReceiver objects and transfer param-values map
     for (auto & ptr : getReceivers(row_index, args))
       ptr.first->transfer(ptr.second);
   }
 }

◆ executeFromMultiapp()

void StochasticToolsTransfer::executeFromMultiapp ( )

virtualinherited

Reimplemented in SamplerPostprocessorTransfer, SamplerReporterTransfer, SerializedSolutionTransfer, PODSamplerSolutionTransfer, and PODResidualTransfer.

Definition at line 116 of file StochasticToolsTransfer.C.

117 {

118 }

◆ executeToMultiapp()

void SamplerParameterTransfer::executeToMultiapp ( )

overridevirtual

Methods used when running in batch mode (see SamplerFullSolveMultiApp)

Reimplemented from StochasticToolsTransfer.

Definition at line 80 of file SamplerParameterTransfer.C.

 {
   if (getToMultiApp()->isRootProcessor())
   {
     // Get the command line arguments
     const auto args = SamplerFullSolveMultiApp::sampledCommandLineArgs(_row_data, _parameter_names);
 
     // Get the sub-app SamplerReceiver objects and transfer param-values map
     for (auto & ptr : getReceivers(_app_index, args))
       ptr.first->transfer(ptr.second);
   }
 }

◆ finalizeFromMultiapp()

void StochasticToolsTransfer::finalizeFromMultiapp ( )

virtualinherited

Reimplemented in SamplerPostprocessorTransfer, SamplerReporterTransfer, SerializedSolutionTransfer, PODSamplerSolutionTransfer, and PODResidualTransfer.

Definition at line 121 of file StochasticToolsTransfer.C.

122 {

123 }

◆ finalizeToMultiapp()

void StochasticToolsTransfer::finalizeToMultiapp ( )

virtualinherited

Reimplemented in SerializedSolutionTransfer, and PODSamplerSolutionTransfer.

Definition at line 136 of file StochasticToolsTransfer.C.

137 {

138 }

◆ getMultiAppProblemsHelper()

std::vector< FEProblemBase * > SamplerParameterTransfer::getMultiAppProblemsHelper	(	FEProblemBase &	base_problem,
		const std::vector< std::string > &	multiapp_names
	)

staticprivate

Helper function that recursively finds feproblem pointers from nested multiapps.

Definition at line 164 of file SamplerParameterTransfer.C.

Referenced by getReceivers().

 {
   // This is what we'll return
   std::vector<FEProblemBase *> problems;
 
   if (multiapp_names.empty()) // Stop recursion if no nested apps provided
     problems.push_back(&base_problem);
   else
   {
     // Get the name of highest level app provided and the index if provided
     std::string sub_name;
     int sub_num = -1;
     pcrecpp::RE("(\\S*?)(\\d*)").FullMatch(multiapp_names[0], &sub_name, &sub_num);
     MultiApp & multiapp = *base_problem.getMultiApp(sub_name);
 
     // Get the app indices (either the requested one or all of them)
     std::pair<unsigned int, unsigned int> app_ind;
     if (sub_num == -1) // There was no number provided, so get all the local sub apps
       app_ind = std::make_pair(multiapp.firstLocalApp(),
                                multiapp.firstLocalApp() + multiapp.numLocalApps());
     else if (multiapp.hasLocalApp(sub_num)) // Number provided, get that app if owned
       app_ind = std::make_pair(sub_num, sub_num + 1);
     else // This processor doesn't own the app index provided
       return {};
 
     // Get all the nested subapps with recursion
     std::vector<std::string> nested_names(multiapp_names.begin() + 1, multiapp_names.end());
     for (unsigned int i = app_ind.first; i < app_ind.second; ++i)
       for (auto & prob : getMultiAppProblemsHelper(multiapp.appProblemBase(i), nested_names))
         problems.push_back(prob);
   }
 
   return problems;
 }

◆ getReceivers()

std::map< SamplerReceiver *, std::map< std::string, std::vector< Real > > > SamplerParameterTransfer::getReceivers	(	unsigned int	app_index,
		const std::vector< std::string > &	args
	)

protected

Based on command line args, return a map between SamplerReceiver objects and the parameter-value pairs.

Parameters

app_index	The global sup-app index
args	The command line args

Returns: A map between the SamplerReceiver object and the parameter-value pairs

Definition at line 94 of file SamplerParameterTransfer.C.

Referenced by execute(), and executeToMultiapp().

 {
   // These are the receivers we are returning
   std::map<SamplerReceiver *, std::map<std::string, std::vector<Real>>> ptrs;
 
   // Split all the input parameters to retrieve receivers and set param-values pairs
   // Cache the multiapp-reciever mapping
   std::unordered_map<std::string, std::vector<SamplerReceiver *>> multiapp_receivers;
   for (const auto & param : args)
   {
     // Get MultiApp Name
     std::string multiapp_name = getToMultiApp()->name();
     const auto pos = param.rfind(":");
     if (pos != std::string::npos)
       multiapp_name += ":" + param.substr(0, pos);
     // Get parameter name
     const auto pos2 = param.rfind("=");
     if (pos2 == std::string::npos)
       mooseError("Internal error: Improper command-line format\n   ", param, ".");
     const std::string param_name = param.substr(pos + 1, pos2 - pos - 1);
 
     // Get values
     const std::string vstr = param.substr(pos2 + 1);
     const auto vpos1 = vstr.find("'");
     const auto vpos2 = vstr.rfind("'");
     std::vector<Real> value;
     if (!MooseUtils::tokenizeAndConvert(vstr.substr(vpos1 + 1, vpos2 - vpos1 - 1), value, " "))
       mooseError("Internal error: Improper command-line format\n   ", param, ".");
 
     // Find receivers if we haven't already found them
     if (multiapp_receivers.find(multiapp_name) == multiapp_receivers.end())
     {
       auto & recvs = multiapp_receivers[multiapp_name]; // Convenience
       // Split the <sub>:<subsub>:<subsubsub> syntax
       const std::vector<std::string> nested_names = MooseUtils::split(multiapp_name, ":");
       // Find all the appropriate FEProblemBases based on the parameter syntax and get a
       // SamplerReceiver
       for (const auto & problem : getMultiAppProblemsHelper(
                getToMultiApp()->appProblemBase(app_index),
                std::vector<std::string>(nested_names.begin() + 1, nested_names.end())))
       {
         // Loop through all the active controls and find one that is a SamplerReciever
         SamplerReceiver * recv_ptr = nullptr;
         for (const auto & control_ptr : problem->getControlWarehouse().getActiveObjects())
         {
           recv_ptr = dynamic_cast<SamplerReceiver *>(control_ptr.get());
           if (recv_ptr)
             break;
         }
         if (!recv_ptr)
           paramError("parameters",
                      "The sub-application (",
                      multiapp_name,
                      ") does not contain a SamplerReceiver control object.");
 
         // Insert the found receiver
         recvs.push_back(recv_ptr);
       }
     }
 
     // Add the parameter and value to the reciever map
     for (const auto & recv_ptr : multiapp_receivers[multiapp_name])
       ptrs[recv_ptr][param_name] = value;
   }
 
   return ptrs;
 }

◆ initializeFromMultiapp()

void StochasticToolsTransfer::initializeFromMultiapp ( )

virtualinherited

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

Reimplemented in SamplerPostprocessorTransfer, SamplerReporterTransfer, SerializedSolutionTransfer, PODSamplerSolutionTransfer, and PODResidualTransfer.

Definition at line 111 of file StochasticToolsTransfer.C.

112 {

113 }

◆ 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 }

◆ 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

◆ validParams()

InputParameters SamplerParameterTransfer::validParams ( )

static

Definition at line 26 of file SamplerParameterTransfer.C.

 {
   InputParameters params = StochasticToolsTransfer::validParams();
   params.addClassDescription("Copies Sampler data to a SamplerReceiver object.");
   params.suppressParameter<MultiMooseEnum>("direction");
   params.suppressParameter<MultiAppName>("multi_app");
   params.addParam<std::vector<std::string>>(
       "parameters",
       "A list of parameters (on the sub application) to control "
       "with the Sampler data. The order of the parameters listed "
       "here should match the order of the items in the Sampler.");
   params.addDeprecatedParam<std::string>(
       "to_control",
       "Unused parameter.",
       "This parameter is no longer used as the SamplerReceiver will automatically be detected.");
   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(), executeToMultiapp(), SerializedSolutionTransfer::initializeInBatchMode(), and StochasticToolsTransfer::setGlobalMultiAppIndex().

◆ _global_index

dof_id_type SamplerParameterTransfer::_global_index

protected

Current global index for batch execution.

Definition at line 53 of file SamplerParameterTransfer.h.

◆ _parameter_names

const std::vector<std::string>& SamplerParameterTransfer::_parameter_names

protected

Storage for the list of parameters to control.

Definition at line 50 of file SamplerParameterTransfer.h.

Referenced by execute(), and executeToMultiapp().

◆ _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 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 execute(), PODSamplerSolutionTransfer::execute(), SerializedSolutionTransfer::execute(), SamplerReporterTransfer::execute(), SamplerPostprocessorTransfer::execute(), SamplerPostprocessorTransfer::initializeFromMultiapp(), SamplerReporterTransfer::intitializeStochasticReporters(), StochasticToolsTransfer::StochasticToolsTransfer(), SerializedSolutionTransfer::transferInParallel(), and SamplerReporterTransfer::transferStochasticReporters().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SamplerParameterTransfer()

Member Function Documentation

◆ execute()

◆ executeFromMultiapp()

◆ executeToMultiapp()

◆ finalizeFromMultiapp()

◆ finalizeToMultiapp()

◆ getMultiAppProblemsHelper()

◆ getReceivers()

◆ initializeFromMultiapp()

◆ initializeToMultiapp()

◆ setCurrentRow()

◆ setGlobalMultiAppIndex()

◆ setGlobalRowIndex()

◆ validParams()

Member Data Documentation

◆ _app_index

◆ _global_index

◆ _parameter_names

◆ _row_data

◆ _sampler_ptr