SamplerFullSolveMultiApp Class Reference

#include <SamplerFullSolveMultiApp.h>

Inheritance diagram for SamplerFullSolveMultiApp:

Public Member Functions
	SamplerFullSolveMultiApp (const InputParameters &parameters)
virtual bool	solveStep (Real dt, Real target_time, bool auto_advance=true) override

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual std::string	getCommandLineArgsParamHelper (unsigned int local_app) override
	Override to allow for batch mode to get correct cli_args. More...

Protected Attributes
Sampler &	_sampler
	Sampler to utilize for creating MultiApps. More...
const StochasticTools::MultiAppMode	_mode
	The Sup-application solve mode. More...
dof_id_type	_local_batch_app_index
	Counter for extracting command line arguments in batch mode. More...

Private Member Functions
bool	solveStepBatch (Real dt, Real target_time, bool auto_advance=true)
	Helper method for running in mode='batch'. More...
std::vector< std::shared_ptr< StochasticToolsTransfer > >	getActiveStochasticToolsTransfers (Transfer::DIRECTION direction)
	Helper for getting StochasticToolsTransfer objects. More...

Detailed Description

Definition at line 25 of file SamplerFullSolveMultiApp.h.

Constructor & Destructor Documentation

SamplerFullSolveMultiApp()

SamplerFullSolveMultiApp::SamplerFullSolveMultiApp

(

const InputParameters &

parameters

)

Definition at line 45 of file SamplerFullSolveMultiApp.C.

  : FullSolveMultiApp(parameters),
    SamplerInterface(this),
    _sampler(SamplerInterface::getSampler("sampler")),
    _mode(getParam<MooseEnum>("mode").getEnum<StochasticTools::MultiAppMode>()),
    _local_batch_app_index(0)
{
  if (_mode == StochasticTools::MultiAppMode::BATCH_RESET ||
      _mode == StochasticTools::MultiAppMode::BATCH_RESTORE)
    init(n_processors());
 
  else
    init(_sampler.getNumberOfRows());
}

Member Function Documentation

getActiveStochasticToolsTransfers()

std::vector< std::shared_ptr< StochasticToolsTransfer > > SamplerFullSolveMultiApp::getActiveStochasticToolsTransfers ( Transfer::DIRECTION  direction )

private

Helper for getting StochasticToolsTransfer objects.

Definition at line 138 of file SamplerFullSolveMultiApp.C.

{
  std::vector<std::shared_ptr<StochasticToolsTransfer>> output;
  const ExecuteMooseObjectWarehouse<Transfer> & warehouse =
      _fe_problem.getMultiAppTransferWarehouse(direction);
  for (std::shared_ptr<Transfer> transfer : warehouse.getActiveObjects())
  {
    auto ptr = std::dynamic_pointer_cast<StochasticToolsTransfer>(transfer);
    if (ptr)
      output.push_back(ptr);
  }
  return output;
}

Referenced by solveStepBatch().

getCommandLineArgsParamHelper()

std::string SamplerFullSolveMultiApp::getCommandLineArgsParamHelper ( unsigned int  local_app )

overrideprotectedvirtual

Override to allow for batch mode to get correct cli_args.

Definition at line 153 of file SamplerFullSolveMultiApp.C.

{
  // Since we only store param_names in cli_args, we need to find the values for each param from
  // sampler data and combine them to get full command line option strings.
  std::vector<Real> row = _sampler.getNextLocalRow();
 
  std::ostringstream oss;
  const std::vector<std::string> & cli_args_name =
      MooseUtils::split(FullSolveMultiApp::getCommandLineArgsParamHelper(local_app), ";");
 
  for (dof_id_type col = 0; col < _sampler.getNumberOfCols(); ++col)
  {
    if (col > 0)
      oss << ";";
    oss << cli_args_name[col] << "=" << Moose::stringify(row[col]);
  }
  return oss.str();
}

solveStep()

bool SamplerFullSolveMultiApp::solveStep ( Real  dt, Real  target_time, bool  auto_advance = true  )

overridevirtual

Definition at line 61 of file SamplerFullSolveMultiApp.C.

{
  mooseAssert(_my_num_apps, _sampler.getNumberOfLocalRows());
 
  bool last_solve_converged = true;
  if (_mode == StochasticTools::MultiAppMode::BATCH_RESET ||
      _mode == StochasticTools::MultiAppMode::BATCH_RESTORE)
    last_solve_converged = solveStepBatch(dt, target_time, auto_advance);
  else
    last_solve_converged = FullSolveMultiApp::solveStep(dt, target_time, auto_advance);
  return last_solve_converged;
}

solveStepBatch()

bool SamplerFullSolveMultiApp::solveStepBatch ( Real  dt, Real  target_time, bool  auto_advance = true  )

private

Helper method for running in mode='batch'.

Definition at line 75 of file SamplerFullSolveMultiApp.C.

{
  // Value to return
  bool last_solve_converged = true;
 
  // List of active relevant Transfer objects
  std::vector<std::shared_ptr<StochasticToolsTransfer>> to_transfers =
      getActiveStochasticToolsTransfers(MultiAppTransfer::TO_MULTIAPP);
  std::vector<std::shared_ptr<StochasticToolsTransfer>> from_transfers =
      getActiveStochasticToolsTransfers(MultiAppTransfer::FROM_MULTIAPP);
 
  // Initialize to/from transfers
  for (auto transfer : to_transfers)
    transfer->initializeToMultiapp();
 
  for (auto transfer : from_transfers)
    transfer->initializeFromMultiapp();
 
  if (_mode == StochasticTools::MultiAppMode::BATCH_RESTORE)
    backup();
 
  // Perform batch MultiApp solves
  _local_batch_app_index = 0;
  for (dof_id_type i = _sampler.getLocalRowBegin(); i < _sampler.getLocalRowEnd(); ++i)
  {
    for (auto & transfer : to_transfers)
    {
      transfer->setGlobalMultiAppIndex(i);
      transfer->executeToMultiapp();
    }
 
    last_solve_converged = FullSolveMultiApp::solveStep(dt, target_time, auto_advance);
 
    for (auto & transfer : from_transfers)
    {
      transfer->setGlobalMultiAppIndex(i);
      transfer->executeFromMultiapp();
    }
 
    if (i < _sampler.getLocalRowEnd() - 1)
    {
      if (_mode == StochasticTools::MultiAppMode::BATCH_RESTORE)
        restore();
      else
      {
        // The app is being reset for the next loop, thus the batch index must be indexed as such
        _local_batch_app_index = i + 1;
        resetApp(_local_batch_app_index, target_time);
        initialSetup();
      }
    }
  }
 
  // Finalize to/from transfers
  for (auto transfer : to_transfers)
    transfer->finalizeToMultiapp();
  for (auto transfer : from_transfers)
    transfer->finalizeFromMultiapp();
 
  return last_solve_converged;
}

Referenced by solveStep().

validParams()

InputParameters SamplerFullSolveMultiApp::validParams ( )

static

Definition at line 20 of file SamplerFullSolveMultiApp.C.

{
  InputParameters params = FullSolveMultiApp::validParams();
  params += SamplerInterface::validParams();
  params.addClassDescription(
      "Creates a full-solve type sub-application for each row of each Sampler matrix.");
  params.addParam<SamplerName>("sampler", "The Sampler object to utilize for creating MultiApps.");
  params.suppressParameter<std::vector<Point>>("positions");
  params.suppressParameter<bool>("output_in_position");
  params.suppressParameter<std::vector<FileName>>("positions_file");
  params.suppressParameter<Real>("move_time");
  params.suppressParameter<std::vector<Point>>("move_positions");
  params.suppressParameter<std::vector<unsigned int>>("move_apps");
  params.set<bool>("use_positions") = false;
 
  MooseEnum modes("normal=0 batch-reset=1 batch-restore=2", "normal");
  params.addParam<MooseEnum>(
      "mode",
      modes,
      "The operation mode, 'normal' creates one sub-application for each row in the Sampler and "
      "'batch' creates on sub-application for each processor and re-executes for each row.");
 
  return params;
}

Member Data Documentation

_local_batch_app_index

dof_id_type SamplerFullSolveMultiApp::_local_batch_app_index

protected

Counter for extracting command line arguments in batch mode.

Definition at line 42 of file SamplerFullSolveMultiApp.h.

Referenced by solveStepBatch().

_mode

const StochasticTools::MultiAppMode SamplerFullSolveMultiApp::_mode

protected

The Sup-application solve mode.

Definition at line 39 of file SamplerFullSolveMultiApp.h.

Referenced by SamplerFullSolveMultiApp(), solveStep(), and solveStepBatch().

_sampler

Sampler& SamplerFullSolveMultiApp::_sampler

protected

Sampler to utilize for creating MultiApps.

Definition at line 36 of file SamplerFullSolveMultiApp.h.

Referenced by getCommandLineArgsParamHelper(), SamplerFullSolveMultiApp(), solveStep(), and solveStepBatch().

---

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

• stochastic_tools/include/multiapps/SamplerFullSolveMultiApp.h
• stochastic_tools/src/multiapps/SamplerFullSolveMultiApp.C