StochasticToolsTransfer Class Reference

The class creates an additional API to allow Transfers to work when running the StochasticTools<FullSolve/Transient>MultiApp objects in batch-mode. More...

#include <StochasticToolsTransfer.h>

Inheritance diagram for StochasticToolsTransfer:

Public Member Functions
	StochasticToolsTransfer (const InputParameters &parameters)
void	setGlobalMultiAppIndex (dof_id_type index)
	Method for keeping track of the global MultiApp index when running in batch mode. More...
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	executeToMultiapp ()
virtual void	finalizeToMultiapp ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
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

The class creates an additional API to allow Transfers to work when running the StochasticTools<FullSolve/Transient>MultiApp objects in batch-mode.

Definition at line 24 of file StochasticToolsTransfer.h.

Constructor & Destructor Documentation

StochasticToolsTransfer()

StochasticToolsTransfer::StochasticToolsTransfer

(

const InputParameters &

parameters

)

Definition at line 26 of file StochasticToolsTransfer.C.

  : MultiAppTransfer(parameters), SamplerInterface(this)
{
  // When the MultiApp is running in batch mode the execute flags for the transfer object must
  // be removed. If not the 'regular' transfer that occurs will potentially destroy data
  // populated during the calls from the MultiApp in batch mode. To prevent the Transfer from
  // running the execute flags must be removed. This is done automatically here, unless
  // 'execute_on' was modified by the user, which an error is produced.
  if (_multi_app->isParamValid("mode") &&
      (_multi_app->getParamTempl<MooseEnum>("mode") == "batch-reset" ||
       _multi_app->getParamTempl<MooseEnum>("mode") == "batch-restore"))
  {
    if (parameters.isParamSetByUser("execute_on"))
      paramError("execute_on",
                 "The 'execute_on' parameter for the '",
                 name(),
                 "' transfer was set, but the parent MultiApp object (",
                 _multi_app->name(),
                 ") is running in 'batch' mode. For this case the 'execute_on' parameter must not "
                 "be set by the user or set to NONE.");
    else
    {
      ExecFlagEnum & exec_flags = const_cast<ExecFlagEnum &>(getParam<ExecFlagEnum>("execute_on"));
      exec_flags = EXEC_NONE;
    }
  }
 
  // In the validParams method above the 'check_multiapp_execute_on' is disabled. This is required
  // to allow for the error above to be triggered. If the 'execute_on' is set by the without
  // the 'check_multiapp_execute_on' flag the above if statement may not be reached. Therefore,
  // a bit of a trick is performed to allow the above check to run first and then the regular
  // check.
  //
  // If the else statement is reached then the user is not running in batch mode, so the
  // 'check_multiapp_execute_on' is a valid check to perform. If the 'check_multiapp_execute_on'
  // has not been set, then the user wants the check to be performed, so do it.
  else if (!parameters.isParamSetByUser("check_multiapp_execute_on"))
    checkMultiAppExecuteOn();
 
  // Determine the Sampler
  if (isParamValid("sampler"))
  {
    _sampler_ptr = &(getSampler("sampler"));
 
    SamplerTransientMultiApp * ptr_transient =
        dynamic_cast<SamplerTransientMultiApp *>(_multi_app.get());
    SamplerFullSolveMultiApp * ptr_fullsolve =
        dynamic_cast<SamplerFullSolveMultiApp *>(_multi_app.get());
 
    if (!ptr_transient && !ptr_fullsolve)
      mooseError("The 'multi_app' parameter must provide either a 'SamplerTransientMultiApp' or "
                 "'SamplerFullSolveMultiApp' object.");
 
    if ((ptr_transient && &(ptr_transient->getSampler("sampler")) != _sampler_ptr) ||
        (ptr_fullsolve && &(ptr_fullsolve->getSampler("sampler")) != _sampler_ptr))
      mooseError("The supplied 'multi_app' must have the same Sampler object as this Transfer.");
  }
 
  else
  {
    paramWarning("sampler",
                 "Support for the 'StochasticToolsTransfer' objects without the 'sampler' input "
                 "parameter is being removed, please update your input file(s).");
 
    std::shared_ptr<SamplerTransientMultiApp> ptr_transient =
        std::dynamic_pointer_cast<SamplerTransientMultiApp>(_multi_app);
    std::shared_ptr<SamplerFullSolveMultiApp> ptr_fullsolve =
        std::dynamic_pointer_cast<SamplerFullSolveMultiApp>(_multi_app);
 
    if (!ptr_transient && !ptr_fullsolve)
      mooseError("The 'multi_app' parameter must provide either a 'SamplerTransientMultiApp' or "
                 "'SamplerFullSolveMultiApp' object.");
 
    if (ptr_transient)
      _sampler_ptr = &(ptr_transient->getSampler("sampler"));
    else
      _sampler_ptr = &(ptr_fullsolve->getSampler("sampler"));
  }
}

Member Function Documentation

executeFromMultiapp()

void StochasticToolsTransfer::executeFromMultiapp ( )

virtual

Reimplemented in SamplerPostprocessorTransfer.

Definition at line 112 of file StochasticToolsTransfer.C.

{
}

executeToMultiapp()

void StochasticToolsTransfer::executeToMultiapp ( )

virtual

Reimplemented in SamplerParameterTransfer.

Definition at line 127 of file StochasticToolsTransfer.C.

{
}

finalizeFromMultiapp()

void StochasticToolsTransfer::finalizeFromMultiapp ( )

virtual

Reimplemented in SamplerPostprocessorTransfer.

Definition at line 117 of file StochasticToolsTransfer.C.

{
}

finalizeToMultiapp()

void StochasticToolsTransfer::finalizeToMultiapp ( )

virtual

Reimplemented in SamplerParameterTransfer.

Definition at line 132 of file StochasticToolsTransfer.C.

{
}

initializeFromMultiapp()

void StochasticToolsTransfer::initializeFromMultiapp ( )

virtual

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

Reimplemented in SamplerPostprocessorTransfer.

Definition at line 107 of file StochasticToolsTransfer.C.

{
}

initializeToMultiapp()

void StochasticToolsTransfer::initializeToMultiapp ( )

virtual

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

Reimplemented in SamplerParameterTransfer.

Definition at line 122 of file StochasticToolsTransfer.C.

{
}

setGlobalMultiAppIndex()

void StochasticToolsTransfer::setGlobalMultiAppIndex ( dof_id_type  index )

inline

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

static

Definition at line 18 of file StochasticToolsTransfer.C.

{
  InputParameters params = MultiAppTransfer::validParams();
  params.set<bool>("check_multiapp_execute_on", true) = false; // see comments in constructor
  params.addParam<SamplerName>("sampler", "A the Sampler object that Transfer is associated..");
  return params;
}

Referenced by SamplerParameterTransfer::validParams(), and SamplerPostprocessorTransfer::validParams().

Member Data Documentation

_global_index

dof_id_type StochasticToolsTransfer::_global_index = 0

protected

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

Definition at line 58 of file StochasticToolsTransfer.h.

Referenced by setGlobalMultiAppIndex().

_sampler_ptr

Sampler* StochasticToolsTransfer::_sampler_ptr

protected

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

Definition at line 61 of file StochasticToolsTransfer.h.

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

---

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

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