SamplerTransfer Class Reference

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

#include <SamplerTransfer.h>

Inheritance diagram for SamplerTransfer:

Public Member Functions
	SamplerTransfer (const InputParameters &parameters)
virtual void	execute () override

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...
Sampler *	_sampler_ptr
	Pointer to the Sampler object used by the SamplerMultiApp. More...
const std::string &	_receiver_name
	The name of the SamplerReceiver Control object on the sub-application. More...
std::vector< std::pair< unsigned int, unsigned int > >	_multi_app_matrix_row
	The matrix and row for each MultiApp. More...

Detailed Description

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

Definition at line 27 of file SamplerTransfer.h.

Constructor & Destructor Documentation

SamplerTransfer()

SamplerTransfer::SamplerTransfer

(

const InputParameters &

parameters

)

Definition at line 36 of file SamplerTransfer.C.

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

  // Determine the Sampler
  std::shared_ptr<SamplerMultiApp> ptr = std::dynamic_pointer_cast<SamplerMultiApp>(_multi_app);
  if (!ptr)
    mooseError("The 'multi_app' parameter must provide a 'SamplerMultiApp' object.");
  _sampler_ptr = &(ptr->getSampler());

  // Compute the matrix and row for each
  std::vector<DenseMatrix<Real>> out = _sampler_ptr->getSamples();
  for (auto mat = beginIndex(out); mat < out.size(); ++mat)
    for (unsigned int row = 0; row < out[mat].m(); ++row)
      _multi_app_matrix_row.push_back(std::make_pair(mat, row));
}

Member Function Documentation

execute()

void SamplerTransfer::execute ( )

overridevirtual

Definition at line 56 of file SamplerTransfer.C.

{
  // Get the Sampler data
  const std::vector<DenseMatrix<Real>> samples = _sampler_ptr->getSamples();

  // Loop over all sub-apps
  for (unsigned int app_index = 0; app_index < _multi_app->numGlobalApps(); app_index++)
  {
    // Do nothing if the sub-app is not local
    if (!_multi_app->hasLocalApp(app_index))
      continue;

    // Get the sub-app SamplerReceiver object and perform error checking
    SamplerReceiver * ptr = getReceiver(app_index);

    // Populate the row of data to transfer
    std::pair<unsigned int, unsigned int> loc = _multi_app_matrix_row[app_index];
    std::vector<Real> row;
    row.reserve(samples[loc.first].n());
    for (unsigned int j = 0; j < samples[loc.first].n(); ++j)
      row.emplace_back(samples[loc.first](loc.second, j));

    // Perform the transfer
    ptr->transfer(_parameter_names, row);
  }
}

getReceiver()

SamplerReceiver * SamplerTransfer::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 84 of file SamplerTransfer.C.

Referenced by execute().

{
  // 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;
}

Member Data Documentation

_multi_app_matrix_row

std::vector<std::pair<unsigned int, unsigned int> > SamplerTransfer::_multi_app_matrix_row

protected

The matrix and row for each MultiApp.

Definition at line 50 of file SamplerTransfer.h.

Referenced by execute(), and SamplerTransfer().

_parameter_names

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

protected

Storage for the list of parameters to control.

Definition at line 41 of file SamplerTransfer.h.

Referenced by execute().

_receiver_name

const std::string& SamplerTransfer::_receiver_name

protected

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

Definition at line 47 of file SamplerTransfer.h.

Referenced by getReceiver().

_sampler_ptr

Sampler* SamplerTransfer::_sampler_ptr

protected

Pointer to the Sampler object used by the SamplerMultiApp.

Definition at line 44 of file SamplerTransfer.h.

Referenced by execute(), and SamplerTransfer().

---

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

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