#include <SamplerTransientMultiApp.h>

Inheritance diagram for SamplerTransientMultiApp:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SamplerTransientMultiApp (const InputParameters &parameters)

virtual bool	solveStep (Real dt, Real target_time, bool auto_advance=true) override
	Override solveStep to allow for batch execution.

virtual void	initialSetup () override
	Override to initialize batch backups.

virtual NumericVector< Number > &	appTransferVector (unsigned int app, std::string var_name) override

virtual void	incrementTStep (Real target_time) override

virtual void	finishStep (bool recurse_through_multiapp_levels=false) override

virtual void	resetApp (unsigned int global_app, Real time) override

Real	computeDT ()

virtual void	preExecute ()

virtual void	finalize ()

virtual void	postExecute ()

void	setupPositions ()

virtual void	createLocalApp (const unsigned int i)

virtual void	preTransfer (Real dt, Real target_time)

virtual void	backup ()

virtual void	restore (bool force=true)

bool	needsRestoration ()

virtual Executioner *	getExecutioner (unsigned int app)

virtual libMesh::BoundingBox	getBoundingBox (unsigned int app, bool displaced_mesh, const MultiAppCoordTransform *coord_transform=nullptr)

FEProblemBase &	problemBase ()

FEProblemBase &	appProblemBase (unsigned int app)

FEProblem &	appProblem (unsigned int app)

const UserObject &	appUserObjectBase (unsigned int app, const std::string &name)

Real	appPostprocessorValue (unsigned int app, const std::string &name)

unsigned int	numGlobalApps () const

unsigned int	numLocalApps ()

unsigned int	firstLocalApp ()

bool	isFirstLocalRank () const

bool	hasApp ()

bool	hasLocalApp (unsigned int global_app) const

MooseApp *	localApp (unsigned int local_app)

const Point &	position (unsigned int app) const

virtual void	moveApp (unsigned int global_app, Point p)

virtual void	parentOutputPositionChanged ()

MPI_Comm &	comm ()

const Parallel::Communicator &	comm () const

bool	isRootProcessor ()

bool	usingPositions () const

bool	runningInPosition () const

void	addAssociatedTransfer (MultiAppTransfer &transfer)

void	setAppOutputFileBase ()

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

PerfGraph &	perfGraph ()

processor_id_type	n_processors () const

processor_id_type	processor_id () const

T &	getSampler (const std::string &name)

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

static void	transformBoundingBox (libMesh::BoundingBox &box, const MultiAppCoordTransform &transform)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

Protected Member Functions
virtual std::vector< std::string >	getCommandLineArgs (const unsigned int local_app) override
	Override to allow to get correct cli_args.

void	setAppOutputFileBase (unsigned int index)

virtual std::vector< std::string >	cliArgs () const

virtual void	fillPositions ()

void	readCommandLineArguments ()

void	createApp (unsigned int i, Real start_time)

virtual bool	propagateRecoverToSubApps () const

void	buildComm ()

unsigned int	globalAppToLocal (unsigned int global_app)

virtual void	preRunInputFile ()

void	init (unsigned int num_apps, bool batch_mode=false)

void	init (unsigned int num_apps, const LocalRankConfig &config)

void	createApps ()

void	keepSolutionDuringRestore (bool keep_solution_during_restore)

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

Static Protected Member Functions
static std::string	getMultiAppName (const std::string &base_name, dof_id_type index, dof_id_type total)

Protected Attributes
Sampler &	_sampler
	Sampler to utilize for creating MultiApps.

const StochasticTools::MultiAppMode	_mode
	The Sup-application solve mode.

dof_id_type	_local_batch_app_index
	Counter for extracting command line arguments in batch mode.

FEProblemBase &	_fe_problem

std::string	_app_type

std::vector< Point >	_positions

std::vector< const Positions * >	_positions_objs

std::vector< unsigned int >	_positions_index_offsets

const bool	_use_positions

std::vector< FileName >	_input_files

const bool &	_wait_for_first_app_init

std::vector< unsigned int >	_npositions_inputfile

std::string	_output_base

unsigned int	_total_num_apps

unsigned int	_my_num_apps

unsigned int	_first_local_app

const MPI_Comm &	_orig_comm

libMesh::Parallel::Communicator	_my_communicator

MPI_Comm &	_my_comm

int	_orig_num_procs

int	_orig_rank

std::string	_node_name

int	_my_rank

std::vector< std::shared_ptr< MooseApp > >	_apps

std::vector< bool >	_has_bounding_box

std::vector< libMesh::BoundingBox >	_bounding_box

Real	_inflation

Point	_bounding_box_padding

processor_id_type	_max_procs_per_app

processor_id_type	_min_procs_per_app

bool	_output_in_position

const Real	_global_time_offset

std::vector< Real >	_reset_times

std::vector< unsigned int >	_reset_apps

std::vector< bool >	_reset_happened

Real	_move_time

std::vector< unsigned int >	_move_apps

std::vector< Point >	_move_positions

bool	_move_happened

bool	_has_an_app

const std::vector< CLIArgString > &	_cli_args

std::vector< std::string >	_cli_args_from_file

bool	_keep_solution_during_restore

bool	_keep_aux_solution_during_restore

const bool	_no_restore

std::vector< std::vector< std::unique_ptr< libMesh::NumericVector< Real > > > >	_end_solutions

std::vector< std::unique_ptr< NumericVector< Real > > >	_end_aux_solutions

LocalRankConfig	_rank_config

std::vector< MultiAppTransfer * >	_associated_transfers

const bool	_run_in_position

SubAppBackups &	_sub_app_backups

const PerfID	_solve_step_timer

const PerfID	_init_timer

const PerfID	_backup_timer

const PerfID	_restore_timer

const PerfID	_reset_timer

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
bool	solveStepBatch (Real dt, Real target_time, bool auto_advance=true)
	Helper method for running in mode='batch'.

void	updateRowData (dof_id_type local_index)
	Helper function for updating _row_data and _local_row_index.

std::vector< std::shared_ptr< StochasticToolsTransfer > >	getActiveStochasticToolsTransfers (Transfer::DIRECTION direction)
	Helper for getting StochasticToolsTransfer objects.

void	setupApp (unsigned int i, Real time=0.0)

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const dof_id_type	_number_of_sampler_rows
	Store the number of rows initialized, if this changes error because it doesn't make sense.

std::vector< std::vector< std::unique_ptr< Backup > > >	_batch_backup
	Storage for batch-restore mode; the outer vector if for the local stochastic data and the inner vector is for the number of sub-apps.

std::vector< Real >	_row_data
	Current row of data updated by updateRowData. Used by transfers and setting command line args.

dof_id_type	_local_row_index = std::numeric_limits<dof_id_type>::max()
	Current local index representing _row_data.

std::vector< TransientBase * >	_transient_executioners

bool	_sub_cycling

bool	_interpolate_transfers

bool	_detect_steady_state

bool	_output_sub_cycles

unsigned int	_max_failures

bool	_tolerate_failure

unsigned int	_failures

bool	_catch_up

Real	_max_catch_up_steps

bool &	_first

std::vector< std::string >	_transferred_vars

std::set< dof_id_type >	_transferred_dofs

std::vector< std::map< std::string, unsigned int > >	_output_file_numbers

bool	_auto_advance

std::set< unsigned int >	_reset

bool	_print_sub_cycles

std::optional< std::string >	_cli_args_param

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const RestartableDataMapName	_metaname

std::string	_restartable_name

const InputParameters &	_si_params

FEProblemBase &	_si_feproblem

THREAD_ID	_si_tid

Detailed Description

Definition at line 21 of file SamplerTransientMultiApp.h.

Constructor & Destructor Documentation

◆ SamplerTransientMultiApp()

SamplerTransientMultiApp::SamplerTransientMultiApp ( const InputParameters & parameters )

Definition at line 51 of file SamplerTransientMultiApp.C.

  : TransientMultiApp(parameters),
    SamplerInterface(this),
    _sampler(getSampler("sampler")),
    _mode(getParam<MooseEnum>("mode").getEnum<StochasticTools::MultiAppMode>()),
    _local_batch_app_index(0),
    _number_of_sampler_rows(_sampler.getNumberOfRows())
{
  if (_mode == StochasticTools::MultiAppMode::BATCH_RESET)
    paramError("mode",
               "The supplied mode, '",
               getParam<MooseEnum>("mode"),
               "', currently is not implemented for the SamplerTransientMultiApp, the available "
               "options are 'normal' or 'batch-restore'.");
 
  if (getParam<unsigned int>("min_procs_per_app") !=
          _sampler.getParam<unsigned int>("min_procs_per_row") ||
      getParam<unsigned int>("max_procs_per_app") !=
          _sampler.getParam<unsigned int>("max_procs_per_row"))
    paramError("sampler",
               "Sampler and multiapp communicator configuration inconsistent. Please ensure that "
               "'MultiApps/",
               name(),
               "/min(max)_procs_per_app' and 'Samplers/",
               _sampler.name(),
               "/min(max)_procs_per_row' are the same.");
 
  init(_sampler.getNumberOfRows(),
       _sampler.getRankConfig(_mode == StochasticTools::MultiAppMode::BATCH_RESET ||
                              _mode == StochasticTools::MultiAppMode::BATCH_RESTORE));
}

Member Function Documentation

◆ getActiveStochasticToolsTransfers()

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

private

Helper for getting StochasticToolsTransfer objects.

This is a copy from SamplerFullSolveMultiapp, but the alternative is to create an intermediate base. But, given the inheritance difference between these object that gets rather complex, so a few lines of copied code is better for now.

Definition at line 202 of file SamplerTransientMultiApp.C.

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

Referenced by solveStepBatch().

◆ getCommandLineArgs()

std::vector< std::string > SamplerTransientMultiApp::getCommandLineArgs ( const unsigned int local_app )

overrideprotectedvirtual

Override to allow to get correct cli_args.

Reimplemented from TransientMultiApp.

Definition at line 218 of file SamplerTransientMultiApp.C.

{
  std::vector<std::string> args;
 
  // With multiple processors per app, there are no local rows for non-root processors
  if (isRootProcessor())
  {
    // 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.
    updateRowData(_mode == StochasticTools::MultiAppMode::NORMAL ? local_app
                                                                 : _local_batch_app_index);
    args = SamplerFullSolveMultiApp::sampledCommandLineArgs(
        _row_data, TransientMultiApp::getCommandLineArgs(local_app));
  }
 
  _my_communicator.broadcast(args);
  return args;
}

◆ initialSetup()

void SamplerTransientMultiApp::initialSetup ( )

overridevirtual

Override to initialize batch backups.

Reimplemented from TransientMultiApp.

Definition at line 84 of file SamplerTransientMultiApp.C.

{
  TIME_SECTION("initialSetup", 2, "Setting Up SamplerTransientMultiApp");
 
  TransientMultiApp::initialSetup();
 
  // Perform initial backup for the batch sub-applications
  if (_mode == StochasticTools::MultiAppMode::BATCH_RESTORE)
  {
    dof_id_type n = _rank_config.num_local_sims;
    _batch_backup.resize(n);
    for (MooseIndex(n) i = 0; i < n; ++i)
      for (MooseIndex(_my_num_apps) j = 0; j < _my_num_apps; j++)
        _batch_backup[i].emplace_back(_apps[j]->backup());
  }
}

◆ solveStep()

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

overridevirtual

Override solveStep to allow for batch execution.

Reimplemented from TransientMultiApp.

Definition at line 102 of file SamplerTransientMultiApp.C.

{
  TIME_SECTION("solveStep", 3, "Solving SamplerTransientMultiApp");
 
  if (_sampler.getNumberOfRows() != _number_of_sampler_rows)
    mooseError("The size of the sampler has changed; SamplerTransientMultiApp object do not "
               "support dynamic Sampler output.");
 
  bool last_solve_converged = true;
  if (_mode == StochasticTools::MultiAppMode::BATCH_RESTORE)
    last_solve_converged = solveStepBatch(dt, target_time, auto_advance);
  else
    last_solve_converged = TransientMultiApp::solveStep(dt, target_time, auto_advance);
  return last_solve_converged;
}

◆ solveStepBatch()

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

private

Helper method for running in mode='batch'.

Definition at line 119 of file SamplerTransientMultiApp.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->setGlobalMultiAppIndex(_rank_config.first_local_app_index);
    transfer->initializeToMultiapp();
  }
  for (auto transfer : from_transfers)
  {
    transfer->setGlobalMultiAppIndex(_rank_config.first_local_app_index);
    transfer->initializeFromMultiapp();
  }
 
  // Perform batch MultiApp solves
  _local_batch_app_index = 0;
  for (dof_id_type i = _rank_config.first_local_sim_index;
       i < _rank_config.first_local_sim_index + _rank_config.num_local_sims;
       ++i)
  {
    updateRowData(_local_batch_app_index);
 
    if (_mode == StochasticTools::MultiAppMode::BATCH_RESTORE)
      for (MooseIndex(_my_num_apps) j = 0; j < _my_num_apps; j++)
      {
        _apps[j]->restore(std::move(_batch_backup[_local_batch_app_index][j]), false);
        _apps[j]->finalizeRestore();
      }
 
    SamplerFullSolveMultiApp::execBatchTransfers(to_transfers,
                                                 i,
                                                 _row_data,
                                                 MultiAppTransfer::TO_MULTIAPP,
                                                 _fe_problem.verboseMultiApps(),
                                                 _console);
 
    // Set the file base based on the current row
    for (unsigned int ai = 0; ai < _my_num_apps; ++ai)
    {
      const std::string mname = getMultiAppName(name(), i, _number_of_sampler_rows);
      _apps[ai]->setOutputFileBase(_app.getOutputFileBase() + "_" + mname);
    }
 
    const bool curr_last_solve_converged =
        TransientMultiApp::solveStep(dt, target_time, auto_advance);
    last_solve_converged = last_solve_converged && curr_last_solve_converged;
 
    SamplerFullSolveMultiApp::execBatchTransfers(from_transfers,
                                                 i,
                                                 _row_data,
                                                 MultiAppTransfer::FROM_MULTIAPP,
                                                 _fe_problem.verboseMultiApps(),
                                                 _console);
 
    incrementTStep(target_time);
 
    if (_mode == StochasticTools::MultiAppMode::BATCH_RESTORE)
      for (MooseIndex(_my_num_apps) j = 0; j < _my_num_apps; j++)
        _batch_backup[_local_batch_app_index][j] = _apps[j]->backup();
 
    _local_batch_app_index++;
  }
  _local_batch_app_index = 0;
 
  // 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().

◆ updateRowData()

void SamplerTransientMultiApp::updateRowData ( dof_id_type local_index )

private

Helper function for updating _row_data and _local_row_index.

This allows multiple calls to the same row index

Definition at line 238 of file SamplerTransientMultiApp.C.

{
  if (!isRootProcessor())
    return;
 
  mooseAssert(local_index < _sampler.getNumberOfLocalRows(),
              "Local index must be less than number of local rows.");
 
  if (_row_data.empty() ||
      (_local_row_index == _sampler.getNumberOfLocalRows() - 1 && local_index == 0))
  {
    mooseAssert(local_index == 0,
                "The first time calling updateRowData must have a local index of 0.");
    _local_row_index = 0;
    _row_data = _sampler.getNextLocalRow();
  }
  else if (local_index - _local_row_index == 1)
  {
    _local_row_index++;
    _row_data = _sampler.getNextLocalRow();
  }
 
  mooseAssert(local_index == _local_row_index,
              "Local index must be equal or one greater than the index previously called.");
}

Referenced by getCommandLineArgs(), and solveStepBatch().

◆ validParams()

InputParameters SamplerTransientMultiApp::validParams ( )

static

Definition at line 19 of file SamplerTransientMultiApp.C.

{
  InputParameters params = TransientMultiApp::validParams();
  params += SamplerInterface::validParams();
  params.addClassDescription("Creates a sub-application for each row of each Sampler matrix.");
  params.addRequiredParam<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;
 
  // use "batch-restore=2" to be consistent with SamplerFullSolveMultiApp and use the
  // allow_out_of_range flag to allow the StochasticToolsTransfer object to inspect the MultiApp
  // object parameters without triggering an assert.
  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-reset' and 'batch-restore' creates N sub-applications, where N is the minimum of "
      "'num_rows' in the Sampler and floor(number of processes / min_procs_per_app). To run "
      "the rows in the Sampler, 'batch-reset' will destroy and re-create sub-apps as needed, "
      "whereas the 'batch-restore' will backup and restore sub-apps to the initial state prior "
      "to execution, without destruction.");
 
  return params;
}

Member Data Documentation

◆ _batch_backup

std::vector<std::vector<std::unique_ptr<Backup> > > SamplerTransientMultiApp::_batch_backup

private

Storage for batch-restore mode; the outer vector if for the local stochastic data and the inner vector is for the number of sub-apps.

The later is 1 for this object, but it is included in case that changes in the future or in child classes

Definition at line 78 of file SamplerTransientMultiApp.h.

Referenced by initialSetup(), and solveStepBatch().

◆ _local_batch_app_index

dof_id_type SamplerTransientMultiApp::_local_batch_app_index

protected

Counter for extracting command line arguments in batch mode.

Definition at line 46 of file SamplerTransientMultiApp.h.

Referenced by getCommandLineArgs(), and solveStepBatch().

◆ _local_row_index

dof_id_type SamplerTransientMultiApp::_local_row_index = std::numeric_limits<dof_id_type>::max()

private

Current local index representing _row_data.

Definition at line 83 of file SamplerTransientMultiApp.h.

Referenced by updateRowData().

◆ _mode

const StochasticTools::MultiAppMode SamplerTransientMultiApp::_mode

protected

The Sup-application solve mode.

Definition at line 43 of file SamplerTransientMultiApp.h.

Referenced by getCommandLineArgs(), initialSetup(), SamplerTransientMultiApp(), solveStep(), and solveStepBatch().

◆ _number_of_sampler_rows

const dof_id_type SamplerTransientMultiApp::_number_of_sampler_rows

private

Store the number of rows initialized, if this changes error because it doesn't make sense.

Definition at line 74 of file SamplerTransientMultiApp.h.

Referenced by solveStep(), and solveStepBatch().

◆ _row_data

std::vector<Real> SamplerTransientMultiApp::_row_data

private

Current row of data updated by updateRowData. Used by transfers and setting command line args.

Definition at line 81 of file SamplerTransientMultiApp.h.

Referenced by getCommandLineArgs(), solveStepBatch(), and updateRowData().

◆ _sampler

Sampler& SamplerTransientMultiApp::_sampler

protected

Sampler to utilize for creating MultiApps.

Definition at line 40 of file SamplerTransientMultiApp.h.

Referenced by SamplerTransientMultiApp(), solveStep(), and updateRowData().

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

stochastic_tools/include/multiapps/SamplerTransientMultiApp.h
stochastic_tools/src/multiapps/SamplerTransientMultiApp.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SamplerTransientMultiApp()

Member Function Documentation

◆ getActiveStochasticToolsTransfers()

◆ getCommandLineArgs()

◆ initialSetup()

◆ solveStep()

◆ solveStepBatch()

◆ updateRowData()

◆ validParams()

Member Data Documentation

◆ _batch_backup

◆ _local_batch_app_index

◆ _local_row_index

◆ _mode

◆ _number_of_sampler_rows

◆ _row_data

◆ _sampler