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

#include <SamplerPostprocessorTransfer.h>

Inheritance diagram for SamplerPostprocessorTransfer:

Public Member Functions
	SamplerPostprocessorTransfer (const InputParameters &parameters)

virtual void	initialSetup () override

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


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

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


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

virtual void	executeFromMultiapp () override

virtual void	finalizeFromMultiapp () override

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

const PostprocessorName &	_sub_pp_name
	Name of postprocessor on the sub-applications. More...

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

VectorPostprocessorValue	_current_data
	Temporary storage for batch mode execution. More...

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

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

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 29 of file SamplerPostprocessorTransfer.h.

Constructor & Destructor Documentation

◆ SamplerPostprocessorTransfer()

SamplerPostprocessorTransfer::SamplerPostprocessorTransfer ( const InputParameters & parameters )

Definition at line 50 of file SamplerPostprocessorTransfer.C.

   : StochasticToolsTransfer(parameters),
     _sub_pp_name(isParamValid("postprocessor") ? getParam<PostprocessorName>("postprocessor")
                                                : getParam<PostprocessorName>("from_postprocessor")),
     _master_vpp_name(isParamValid("vector_postprocessor")
                          ? getParam<VectorPostprocessorName>("vector_postprocessor")
                          : getParam<VectorPostprocessorName>("to_vector_postprocessor"))
 {
 }

Member Function Documentation

◆ execute()

void SamplerPostprocessorTransfer::execute ( )

overrideprotectedvirtual

Traditional Transfer callback.

Definition at line 101 of file SamplerPostprocessorTransfer.C.

 {
   VectorPostprocessorValue current;
   current.reserve(_sampler_ptr->getNumberOfLocalRows());
   for (dof_id_type i = _sampler_ptr->getLocalRowBegin(); i < _sampler_ptr->getLocalRowEnd(); ++i)
   {
     FEProblemBase & app_problem = _multi_app->appProblemBase(i);
     current.emplace_back(app_problem.getPostprocessorValue(_sub_pp_name));
   }
   _results->setCurrentLocalVectorPostprocessorValue(_sampler_ptr->name(), std::move(current));
 }

◆ executeFromMultiapp()

void SamplerPostprocessorTransfer::executeFromMultiapp ( )

overrideprotectedvirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 80 of file SamplerPostprocessorTransfer.C.

 {
   const dof_id_type n = _multi_app->numGlobalApps();
   for (MooseIndex(n) i = 0; i < n; i++)
   {
     if (_multi_app->hasLocalApp(i))
     {
       FEProblemBase & app_problem = _multi_app->appProblemBase(i);
       _current_data.emplace_back(app_problem.getPostprocessorValue(_sub_pp_name));
     }
   }
 }

◆ executeToMultiapp()

void StochasticToolsTransfer::executeToMultiapp ( )

virtualinherited

Reimplemented in SamplerParameterTransfer.

Definition at line 127 of file StochasticToolsTransfer.C.

128 {

129 }

◆ finalizeFromMultiapp()

void SamplerPostprocessorTransfer::finalizeFromMultiapp ( )

overrideprotectedvirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 94 of file SamplerPostprocessorTransfer.C.

 {
   _results->setCurrentLocalVectorPostprocessorValue(_sampler_ptr->name(), std::move(_current_data));
   _current_data.clear();
 }

◆ finalizeToMultiapp()

void StochasticToolsTransfer::finalizeToMultiapp ( )

virtualinherited

Reimplemented in SamplerParameterTransfer.

Definition at line 132 of file StochasticToolsTransfer.C.

133 {

134 }

◆ initializeFromMultiapp()

void SamplerPostprocessorTransfer::initializeFromMultiapp ( )

overrideprotectedvirtual

Methods used when running in batch mode (see SamplerFullSolveMultiApp)

Reimplemented from StochasticToolsTransfer.

Definition at line 73 of file SamplerPostprocessorTransfer.C.

 {
   _current_data.clear();
   _current_data.reserve(_sampler_ptr->getNumberOfLocalRows());
 }

◆ initializeToMultiapp()

void StochasticToolsTransfer::initializeToMultiapp ( )

virtualinherited

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

Reimplemented in SamplerParameterTransfer.

Definition at line 122 of file StochasticToolsTransfer.C.

123 {

124 }

◆ initialSetup()

void SamplerPostprocessorTransfer::initialSetup ( )

overridevirtual

Definition at line 61 of file SamplerPostprocessorTransfer.C.

 {
   auto & uo = _fe_problem.getUserObjectTempl<UserObject>(_master_vpp_name);
   _results = dynamic_cast<StochasticResults *>(&uo);
  
   if (!_results)
     mooseError("The 'results' object must be a 'StochasticResults' object.");
  
   _results->init(*_sampler_ptr);
 }

◆ setGlobalMultiAppIndex()

void StochasticToolsTransfer::setGlobalMultiAppIndex ( dof_id_type index )

inlineinherited

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

See StochasticTools<FullSolve/Transient>MultiApp

Definition at line 54 of file StochasticToolsTransfer.h.

54 { _global_index = index; }

◆ validParams()

InputParameters SamplerPostprocessorTransfer::validParams ( )

static

Definition at line 23 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<PostprocessorName>(
       "from_postprocessor", "The name of the Postprocessors 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.addDeprecatedParam<PostprocessorName>(
       "postprocessor",
       "The name of the Postprocessors on the sub-app to transfer from.",
       "Replaced by from_postprocessor");
   params.addDeprecatedParam<VectorPostprocessorName>("vector_postprocessor",
                                                      "The name of the VectorPostprocessor in "
                                                      "the MultiApp to transfer values "
                                                      "to.",
                                                      "Replaced by to_vector_postprocessor");
  
   params.set<MultiMooseEnum>("direction") = "from_multiapp";
   params.suppressParameter<MultiMooseEnum>("direction");
   return params;
 }