SamplerParameterTransfer Class Reference

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

#include <SamplerParameterTransfer.h>

Inheritance diagram for SamplerParameterTransfer:

Public Member Functions
	SamplerParameterTransfer (const InputParameters &parameters)
virtual void	execute () override
	Traditional Transfer callback. More...
void	setGlobalMultiAppIndex (dof_id_type index)
	Method for keeping track of the global MultiApp index when running in batch mode. More...
virtual void	initializeToMultiapp () override
	Methods used when running in batch mode (see SamplerFullSolveMultiApp) More...
virtual void	executeToMultiapp () override
virtual void	finalizeToMultiapp () override
virtual void	initializeFromMultiapp ()
	Methods for transferring data from sub-applications to the master application. More...
virtual void	executeFromMultiapp ()
virtual void	finalizeFromMultiapp ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
SamplerReceiver *	getReceiver (unsigned int app_index)
	Return the SamplerReceiver object and perform error checking. More...

Protected Attributes
const std::vector< std::string > &	_parameter_names
	Storage for the list of parameters to control. More...
const std::string &	_receiver_name
	The name of the SamplerReceiver Control object on the sub-application. More...
dof_id_type	_global_index
	Current global index for batch execution. More...
Sampler *	_sampler_ptr
	Pointer to the Sampler object used by the SamplerTransientMultiApp or SamplerFullSolveMultiApp. 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 43 of file SamplerParameterTransfer.C.

  : StochasticToolsTransfer(parameters),
    _parameter_names(getParam<std::vector<std::string>>("parameters")),
    _receiver_name(getParam<std::string>("to_control"))
{
}

Member Function Documentation

execute()

void SamplerParameterTransfer::execute ( )

overridevirtual

Traditional Transfer callback.

Definition at line 51 of file SamplerParameterTransfer.C.

{
  mooseAssert(_sampler_ptr->getNumberOfLocalRows() == _multi_app->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(_multi_app->hasLocalApp(row_index),
                "The current sample row index is not a valid global MultiApp index.");
 
    // Get the sub-app SamplerReceiver object and perform error checking
    SamplerReceiver * ptr = getReceiver(row_index);
 
    // Populate the row of data to transfer
    std::vector<Real> row = _sampler_ptr->getNextLocalRow();
 
    // Perform the transfer
    ptr->transfer(_parameter_names, row);
  }
}

executeFromMultiapp()

void StochasticToolsTransfer::executeFromMultiapp ( )

virtualinherited

Reimplemented in SamplerPostprocessorTransfer.

Definition at line 112 of file StochasticToolsTransfer.C.

{
}

executeToMultiapp()

void SamplerParameterTransfer::executeToMultiapp ( )

overridevirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 82 of file SamplerParameterTransfer.C.

{
  SamplerReceiver * ptr = getReceiver(processor_id());
 
  std::vector<Real> row = _sampler_ptr->getNextLocalRow();
 
  ptr->transfer(_parameter_names, row);
 
  _global_index++;
}

finalizeFromMultiapp()

void StochasticToolsTransfer::finalizeFromMultiapp ( )

virtualinherited

Reimplemented in SamplerPostprocessorTransfer.

Definition at line 117 of file StochasticToolsTransfer.C.

{
}

finalizeToMultiapp()

void SamplerParameterTransfer::finalizeToMultiapp ( )

overridevirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 94 of file SamplerParameterTransfer.C.

{
}

getReceiver()

SamplerReceiver * SamplerParameterTransfer::getReceiver ( unsigned int  app_index )

protected

Return the SamplerReceiver object and perform error checking.

Parameters

app_index

The global sup-app index

Definition at line 99 of file SamplerParameterTransfer.C.

{
  // Test that the sub-application has the given Control object
  FEProblemBase & to_problem = _multi_app->appProblemBase(app_index);
  ExecuteMooseObjectWarehouse<Control> & control_wh = to_problem.getControlWarehouse();
  if (!control_wh.hasActiveObject(_receiver_name))
    mooseError("The sub-application (",
               _multi_app->name(),
               ") does not contain a Control object with the name '",
               _receiver_name,
               "'.");
 
  SamplerReceiver * ptr =
      dynamic_cast<SamplerReceiver *>(control_wh.getActiveObject(_receiver_name).get());
 
  if (!ptr)
    mooseError(
        "The sub-application (",
        _multi_app->name(),
        ") Control object for the 'to_control' parameter must be of type 'SamplerReceiver'.");
 
  return ptr;
}

Referenced by execute(), and executeToMultiapp().

initializeFromMultiapp()

void StochasticToolsTransfer::initializeFromMultiapp ( )

virtualinherited

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

Reimplemented in SamplerPostprocessorTransfer.

Definition at line 107 of file StochasticToolsTransfer.C.

{
}

initializeToMultiapp()

void SamplerParameterTransfer::initializeToMultiapp ( )

overridevirtual

Methods used when running in batch mode (see SamplerFullSolveMultiApp)

Reimplemented from StochasticToolsTransfer.

Definition at line 76 of file SamplerParameterTransfer.C.

{
  _global_index = _sampler_ptr->getLocalRowBegin();
}

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.

{ _global_index = index; }

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.set<MultiMooseEnum>("direction") = "to_multiapp";
  params.suppressParameter<MultiMooseEnum>("direction");
  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.addRequiredParam<std::string>("to_control",
                                       "The name of the 'SamplerReceiver' on the sub application "
                                       "to which the Sampler data will be transferred.");
  return params;
}

Member Data Documentation

_global_index

dof_id_type SamplerParameterTransfer::_global_index

protected

Current global index for batch execution.

Definition at line 55 of file SamplerParameterTransfer.h.

Referenced by executeToMultiapp(), and initializeToMultiapp().

_parameter_names

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

protected

Storage for the list of parameters to control.

Definition at line 49 of file SamplerParameterTransfer.h.

Referenced by execute(), and executeToMultiapp().

_receiver_name

const std::string& SamplerParameterTransfer::_receiver_name

protected

The name of the SamplerReceiver Control object on the sub-application.

Definition at line 52 of file SamplerParameterTransfer.h.

Referenced by getReceiver().

_sampler_ptr

Sampler* StochasticToolsTransfer::_sampler_ptr

protectedinherited

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

Definition at line 61 of file StochasticToolsTransfer.h.

Referenced by execute(), SamplerPostprocessorTransfer::execute(), executeToMultiapp(), SamplerPostprocessorTransfer::finalizeFromMultiapp(), SamplerPostprocessorTransfer::initializeFromMultiapp(), initializeToMultiapp(), SamplerPostprocessorTransfer::initialSetup(), and StochasticToolsTransfer::StochasticToolsTransfer().

---

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

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