Transfer Postprocessor from sub-applications to a VectorPostprocessor on the master application. More...

#include <SamplerPostprocessorTransfer.h>

Inheritance diagram for SamplerPostprocessorTransfer:

Public Types
enum	DIRECTION

typedef DataFileName	DataFileParameterType

Public Member Functions
	SamplerPostprocessorTransfer (const InputParameters &parameters)

virtual void	initialSetup () override

const std::vector< VectorPostprocessorName > &	vectorNames () const
	The name of the vector to be created on the StochasticResults object, see StochasticResultsAction) 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) 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 &	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 &name, const std::string *param=nullptr) 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 System *	find_sys (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 Number	OutOfMeshValue

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

std::vector< unsigned int >	getFromsPerProc ()

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

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

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

std::vector< BoundingBox >	getFromBoundingBoxes ()

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


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 (BoundingBox &box, const MultiAppCoordTransform &transform)

Protected Attributes
StochasticResults *	_results
	Storage for StochasticResults object that data will be transferred to/from. More...

const std::vector< PostprocessorName > &	_sub_pp_names
	Name of postprocessor on the sub-applications. More...

const VectorPostprocessorName &	_master_vpp_name
	Name of vector-postprocessor on the master. More...

const std::vector< VectorPostprocessorName >	_vpp_names
	Storage vector names. More...

std::vector< VectorPostprocessorValue >	_current_data
	Temporary storage for batch mode execution. More...

const bool	_keep_diverge

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< EquationSystems *>	_to_es

std::vector< 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 Postprocessor from sub-applications to a VectorPostprocessor on the master application.

This object transfers the distributed data to a StochasticResults object.

Definition at line 25 of file SamplerPostprocessorTransfer.h.

Constructor & Destructor Documentation

◆ SamplerPostprocessorTransfer()

SamplerPostprocessorTransfer::SamplerPostprocessorTransfer ( const InputParameters & parameters )

Definition at line 63 of file SamplerPostprocessorTransfer.C.

   : StochasticToolsTransfer(parameters),
     _sub_pp_names(getParam<std::vector<PostprocessorName>>("from_postprocessor")),
     _master_vpp_name(getParam<VectorPostprocessorName>("to_vector_postprocessor")),
     _vpp_names(isParamValid("prefix")
                    ? getVectorNamesHelper(getParam<std::string>("prefix"), _sub_pp_names)
                    : getVectorNamesHelper(_name, _sub_pp_names)),
     _keep_diverge(getParam<bool>("keep_solve_fail_value"))
 {
   if (hasToMultiApp())
     paramError("to_multi_app", "To and between multiapp directions are not implemented");
 }

Member Function Documentation

◆ execute()

void SamplerPostprocessorTransfer::execute ( )

overrideprotectedvirtual

Traditional Transfer callback.

Implements MultiAppTransfer.

Definition at line 156 of file SamplerPostprocessorTransfer.C.

 {
   for (std::size_t j = 0; j < _sub_pp_names.size(); ++j)
   {
     VectorPostprocessorValue current;
     current.reserve(_sampler_ptr->getNumberOfLocalRows());
     for (dof_id_type i = _sampler_ptr->getLocalRowBegin(); i < _sampler_ptr->getLocalRowEnd(); ++i)
     {
       FEProblemBase & app_problem = getFromMultiApp()->appProblemBase(i);
       if (app_problem.converged(/*nl_sys_num=*/0) || _keep_diverge)
         current.emplace_back(app_problem.getPostprocessorValueByName(_sub_pp_names[j]));
       else
         current.emplace_back(std::numeric_limits<double>::quiet_NaN());
     }
     _results->setCurrentLocalVectorPostprocessorValue(_vpp_names[j], std::move(current));
   }
 }

◆ executeFromMultiapp()

void SamplerPostprocessorTransfer::executeFromMultiapp ( )

overrideprotectedvirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 123 of file SamplerPostprocessorTransfer.C.

 {
   if (getFromMultiApp()->isRootProcessor())
   {
     const dof_id_type n = getFromMultiApp()->numGlobalApps();
     for (MooseIndex(n) i = 0; i < n; i++)
     {
       if (getFromMultiApp()->hasLocalApp(i))
       {
         FEProblemBase & app_problem = getFromMultiApp()->appProblemBase(i);
         if (app_problem.converged(/*nl_sys_num=*/0) || _keep_diverge)
           for (std::size_t j = 0; j < _sub_pp_names.size(); ++j)
             _current_data[j].emplace_back(
                 app_problem.getPostprocessorValueByName(_sub_pp_names[j]));
         else
           for (std::size_t j = 0; j < _sub_pp_names.size(); ++j)
             _current_data[j].emplace_back(std::numeric_limits<double>::quiet_NaN());
       }
     }
   }
 }

◆ executeToMultiapp()

void StochasticToolsTransfer::executeToMultiapp ( )

virtualinherited

Reimplemented in SerializedSolutionTransfer, PODSamplerSolutionTransfer, and SamplerParameterTransfer.

Definition at line 131 of file StochasticToolsTransfer.C.

132 {

133 }

◆ finalizeFromMultiapp()

void SamplerPostprocessorTransfer::finalizeFromMultiapp ( )

overrideprotectedvirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 146 of file SamplerPostprocessorTransfer.C.

 {
   for (std::size_t j = 0; j < _sub_pp_names.size(); ++j)
   {
     _results->setCurrentLocalVectorPostprocessorValue(_vpp_names[j], std::move(_current_data[j]));
     _current_data[j].clear();
   }
 }

◆ finalizeToMultiapp()

void StochasticToolsTransfer::finalizeToMultiapp ( )

virtualinherited

Reimplemented in SerializedSolutionTransfer, and PODSamplerSolutionTransfer.

Definition at line 136 of file StochasticToolsTransfer.C.

137 {

138 }

◆ initializeFromMultiapp()

void SamplerPostprocessorTransfer::initializeFromMultiapp ( )

overrideprotectedvirtual

Methods used when running in batch mode (see SamplerFullSolveMultiApp)

Reimplemented from StochasticToolsTransfer.

Definition at line 113 of file SamplerPostprocessorTransfer.C.

 {
   for (VectorPostprocessorValue & current : _current_data)
   {
     current.clear();
     current.reserve(_sampler_ptr->getNumberOfLocalRows());
   }
 }

◆ 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 SamplerPostprocessorTransfer::initialSetup ( )

overridevirtual

Reimplemented from MultiAppTransfer.

Definition at line 83 of file SamplerPostprocessorTransfer.C.

 {
   // Get the StochasticResults VPP object to populate
   auto & uo = _fe_problem.getUserObject<UserObject>(_master_vpp_name);
   _results = dynamic_cast<StochasticResults *>(&uo);
   if (!_results)
     mooseError("The 'results' object must be a 'StochasticResults' object.");
 
   // Check that postprocessor on sub-application exists and create vectors on results VPP
   const dof_id_type n = getFromMultiApp()->numGlobalApps();
   for (MooseIndex(n) i = 0; i < n; i++)
   {
     if (getFromMultiApp()->hasLocalApp(i))
     {
       FEProblemBase & app_problem = getFromMultiApp()->appProblemBase(i);
       for (const auto & sub_pp_name : _sub_pp_names)
         if (!app_problem.hasPostprocessorValueByName(sub_pp_name))
           mooseError("Unknown postprocesssor name '",
                      sub_pp_name,
                      "' on sub-application '",
                      getFromMultiApp()->name(),
                      "'");
     }
   }
 
   // Initialize storage for accumulating VPP data
   _current_data.resize(_sub_pp_names.size());
 }

◆ 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 SamplerPostprocessorTransfer::validParams ( )

static

Definition at line 36 of file SamplerPostprocessorTransfer.C.

 {
   InputParameters params = StochasticToolsTransfer::validParams();
   params.addClassDescription("Transfers data from Postprocessors on the sub-application to a "
                              "VectorPostprocessor on the master application.");
 
   params.addParam<std::vector<PostprocessorName>>(
       "from_postprocessor", "The name(s) of the Postprocessor(s) on the sub-app to transfer from.");
   params.addParam<VectorPostprocessorName>("to_vector_postprocessor",
                                            "The name of the VectorPostprocessor in "
                                            "the MultiApp to transfer values "
                                            "to.");
 
   params.addParam<std::string>("prefix",
                                "Use the supplied string as the prefix for vector postprocessor "
                                "name rather than the transfer name.");
 
   params.addParam<bool>("keep_solve_fail_value",
                         false,
                         "If true, whatever the value the sub app has upon exitting is used. "
                         "If false, NaN will be transferred.");
 
   params.suppressParameter<MultiMooseEnum>("direction");
   params.suppressParameter<MultiAppName>("multi_app");
   return params;
 }