Transfer solutions from sub-applications to a container in a Trainer. More...

#include <PODSamplerSolutionTransfer.h>

Inheritance diagram for PODSamplerSolutionTransfer:

Public Types
enum	DIRECTION

typedef DataFileName	DataFileParameterType

Public Member Functions
	PODSamplerSolutionTransfer (const InputParameters &parameters)

virtual void	initialSetup () override

virtual void	execute () override

void	setGlobalMultiAppIndex (dof_id_type index)
	Method for setting the app index when running in batch mode.

void	setGlobalRowIndex (dof_id_type row)
	Method for keeping track of the global row index when running in batch mode.

void	setCurrentRow (const std::vector< Real > &row)
	Method for keeping track of the row data when running in batch mode.

void	variableIntegrityCheck (const AuxVariableName &var_name, bool is_from_multiapp) const

const std::shared_ptr< MultiApp >	getMultiApp () const

const std::shared_ptr< MultiApp >	getFromMultiApp () const

const std::shared_ptr< MultiApp >	getToMultiApp () const

std::string	getFromName () const

std::string	getToName () const

bool	hasFromMultiApp () const

bool	hasToMultiApp () const

virtual void	getAppInfo ()

const MultiMooseEnum &	directions ()

void	setCurrentDirection (const int direction)

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 ()

MooseEnum	direction ()

MooseEnum	direction ()

MooseEnum	currentDirection ()

MooseEnum	currentDirection ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const


virtual void	initializeFromMultiapp () override
	Methods used when running in batch mode (see SamplerFullSolveMultiApp)

virtual void	executeFromMultiapp () override

virtual void	finalizeFromMultiapp () override

virtual void	initializeToMultiapp () override
	Methods for transferring data to sub-applications to the master application.

virtual void	executeToMultiapp () override

virtual void	finalizeToMultiapp () override

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	addSkipCoordCollapsingParam (InputParameters &params)

static libMesh::System *	find_sys (libMesh::EquationSystems &es, const std::string &var_name)

static std::string	possibleDirections ()

Public Attributes
	TO_MULTIAPP

	FROM_MULTIAPP

	BETWEEN_MULTIAPP

	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const libMesh::Number	OutOfMeshValue

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
std::vector< unsigned int >	getFromsPerProc ()

libMesh::NumericVector< Real > &	getTransferVector (unsigned int i_local, std::string var_name)

unsigned int	getGlobalSourceAppIndex (unsigned int i_from) const

unsigned int	getGlobalTargetAppIndex (unsigned int i_to) const

unsigned int	getLocalSourceAppIndex (unsigned int i_from) const

virtual void	checkSiblingsTransferSupported () const

void	checkParentAppUserObjectExecuteOn (const std::string &object_name) const

void	errorIfObjectExecutesOnTransferInSourceApp (const std::string &object_name) const

Point	getPointInTargetAppFrame (const Point &p, unsigned int local_i_to, const std::string &phase) const

Point	getPointInSourceAppFrame (const Point &p, unsigned int local_i_from, const std::string &phase) const

void	checkMultiAppExecuteOn ()

void	checkVariable (const FEProblemBase &fe_problem, const VariableName &var_name, const std::string &param_name="") const

void	extendBoundingBoxes (const Real factor, std::vector< libMesh::BoundingBox > &bboxes) const

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

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes ()

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes (BoundaryID boundary_id)

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes ()

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes (BoundaryID boundary_id)

Static Protected Member Functions
static void	addUserObjectExecutionCheckParam (InputParameters &params)

static void	addBBoxFactorParam (InputParameters &params)

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

Protected Attributes
std::shared_ptr< PODFullSolveMultiApp >	_pod_multi_app
	The input multiapp casted into a PODFullSolveMultiapp to get access to the specific pod attributes.

PODReducedBasisTrainer &	_trainer
	The trainer object to save the solution vector into or to fetch the artificial solution vectors from.

dof_id_type	_app_index = 0
	Index for the sub-app that the batch-mode multiapp is working on.

dof_id_type	_global_index = 0
	Index for tracking the row index when using batch mode operation.

std::vector< Real >	_row_data
	The current row of data (comes from multiapp)

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

std::shared_ptr< MultiApp >	_multi_app

std::vector< FEProblemBase * >	_to_problems

std::vector< FEProblemBase * >	_from_problems

std::vector< libMesh::EquationSystems * >	_to_es

std::vector< libMesh::EquationSystems * >	_from_es

std::vector< MooseMesh * >	_to_meshes

std::vector< MooseMesh * >	_from_meshes

std::vector< Point >	_to_positions

std::vector< Point >	_from_positions

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_to_transforms

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_from_transforms

const bool	_skip_coordinate_collapsing

bool	_displaced_source_mesh

bool	_displaced_target_mesh

Real	_bbox_factor

std::vector< unsigned int >	_to_local2global_map

std::vector< unsigned int >	_from_local2global_map

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

MultiMooseEnum	_directions

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

MooseEnum	_direction

MooseEnum	_current_direction

const Parallel::Communicator &	_communicator

Private Member Functions
virtual bool	usesMooseAppCoordTransform () const

Point	mapBackWithoutCollapsing (MultiAppCoordTransform &transform, const Point &p, const std::string &phase) const

void	getFromMultiAppInfo ()

void	getToMultiAppInfo ()

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

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

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

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

template<>
SurrogateModel &	getSurrogateModel (const std::string &name) const

template<>
SurrogateTrainerBase &	getSurrogateTrainer (const std::string &name) const

template<>
SurrogateModel &	getSurrogateModelByName (const UserObjectName &name) const

template<>
SurrogateTrainerBase &	getSurrogateTrainerByName (const UserObjectName &name) const


template<typename T = SurrogateModel>
T &	getSurrogateModel (const std::string &name) const
	Get a SurrogateModel/Trainer with a given name.

template<typename T = SurrogateTrainerBase>
T &	getSurrogateTrainer (const std::string &name) const


template<typename T = SurrogateModel>
T &	getSurrogateModelByName (const UserObjectName &name) const
	Get a sampler with a given name.

template<typename T = SurrogateTrainerBase>
T &	getSurrogateTrainerByName (const UserObjectName &name) 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
std::shared_ptr< MultiApp >	_from_multi_app

std::shared_ptr< MultiApp >	_to_multi_app

std::unique_ptr< MooseAppCoordTransform >	_from_moose_app_transform

std::unique_ptr< MooseAppCoordTransform >	_to_moose_app_transform

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

const InputParameters &	_smi_params
	Parameters of the object with this interface.

FEProblemBase &	_smi_feproblem
	Reference to FEProblemBase instance.

const THREAD_ID	_smi_tid
	Thread ID.

Detailed Description

Transfer solutions from sub-applications to a container in a Trainer.

This object also transfers artificial solution vectors back to sub-applications.

Definition at line 24 of file PODSamplerSolutionTransfer.h.

Constructor & Destructor Documentation

◆ PODSamplerSolutionTransfer()

PODSamplerSolutionTransfer::PODSamplerSolutionTransfer ( const InputParameters & parameters )

Definition at line 29 of file PODSamplerSolutionTransfer.C.

  : StochasticToolsTransfer(parameters),
    SurrogateModelInterface(this),
    _pod_multi_app(hasFromMultiApp()
                       ? std::dynamic_pointer_cast<PODFullSolveMultiApp>(getFromMultiApp())
                       : std::dynamic_pointer_cast<PODFullSolveMultiApp>(getToMultiApp())),
    _trainer(getSurrogateTrainer<PODReducedBasisTrainer>("trainer_name"))
{
  if (!_pod_multi_app)
    paramError("multi_app", "The Multiapp given is not a PODFullsolveMultiapp!");
}

Member Function Documentation

◆ execute()

void PODSamplerSolutionTransfer::execute ( )

overridevirtual

Implements MultiAppTransfer.

Reimplemented in PODResidualTransfer.

Definition at line 59 of file PODSamplerSolutionTransfer.C.

{
 
  const std::vector<std::string> & var_names = _trainer.getVarNames();
 
  // Selecting the appropriate action based on the drection.
  switch (_direction)
  {
    case FROM_MULTIAPP:
 
      // Looping over sub-apps created for different samples
      for (dof_id_type i = _sampler_ptr->getLocalRowBegin(); i < _sampler_ptr->getLocalRowEnd();
           ++i)
      {
        // Getting reference to the  solution vector of the sub-app.
        FEProblemBase & app_problem = getFromMultiApp()->appProblemBase(i);
        NonlinearSystemBase & nl = app_problem.getNonlinearSystemBase(/*nl_sys_num=*/0);
        NumericVector<Number> & solution = nl.solution();
 
        // Looping over the variables to extract the corresponding solution values
        // and copy them into the container of the trainer.
        for (unsigned int v_index = 0; v_index < var_names.size(); ++v_index)
        {
          // Getting the corresponding DoF indices for the variable.
          nl.setVariableGlobalDoFs(var_names[v_index]);
          const std::vector<dof_id_type> & var_dofs = nl.getVariableGlobalDoFs();
 
          // Initializing a temporary vector for the partial solution.
          std::shared_ptr<DenseVector<Real>> tmp = std::make_shared<DenseVector<Real>>();
          solution.localize(tmp->get_values(), var_dofs);
 
          // Copying the temporary vector into the trainer.
          _trainer.addSnapshot(v_index, i, tmp);
        }
      }
      break;
 
    case TO_MULTIAPP:
 
      // Looping over all the variables in the trainer to copy the corresponding
      // basis vectors into the solution.
      unsigned int counter = 0;
      for (unsigned int var_i = 0; var_i < var_names.size(); ++var_i)
      {
        // Looping over the bases of the given variable and plugging them into
        // a sub-application.
        unsigned int var_base_num = _trainer.getBaseSize(var_i);
        for (unsigned int base_i = 0; base_i < var_base_num; ++base_i)
        {
          if (getToMultiApp()->hasLocalApp(counter))
          {
            // Getting the reference to the solution vector in the subapp.
            FEProblemBase & app_problem = getToMultiApp()->appProblemBase(counter);
            NonlinearSystemBase & nl = app_problem.getNonlinearSystemBase(/*nl_sys_num=*/0);
            NumericVector<Number> & solution = nl.solution();
 
            // Zeroing the solution to make sure that only the required part
            // is non-zero after copy.
            solution.zero();
 
            // Getting the degrees of freedom for the given variable.
            nl.setVariableGlobalDoFs(var_names[var_i]);
            const std::vector<dof_id_type> & var_dofs = nl.getVariableGlobalDoFs();
 
            // Fetching the basis vector and plugging it into the solution.
            const DenseVector<Real> & base_vector = _trainer.getBasisVector(var_i, base_i);
            solution.insert(base_vector, var_dofs);
            solution.close();
 
            // Make sure that the sub-application uses this vector to evaluate the
            // residual.
            nl.setSolution(solution);
          }
          counter++;
        }
      }
      break;
  }
}

◆ executeFromMultiapp()

void PODSamplerSolutionTransfer::executeFromMultiapp ( )

overridevirtual

Reimplemented from StochasticToolsTransfer.

Reimplemented in PODResidualTransfer.

Definition at line 145 of file PODSamplerSolutionTransfer.C.

{
  if (_pod_multi_app->snapshotGeneration())
  {
    const std::vector<std::string> & var_names = _trainer.getVarNames();
 
    const dof_id_type n = getFromMultiApp()->numGlobalApps();
 
    for (MooseIndex(n) i = 0; i < n; i++)
    {
      if (getFromMultiApp()->hasLocalApp(i))
      {
        // Getting reference to the  solution vector of the sub-app.
        FEProblemBase & app_problem = getFromMultiApp()->appProblemBase(i);
        NonlinearSystemBase & nl = app_problem.getNonlinearSystemBase(/*nl_sys_num=*/0);
        NumericVector<Number> & solution = nl.solution();
 
        // Looping over the variables to extract the corresponding solution values
        // and copy them into the container of the trainer.
        for (unsigned int var_i = 0; var_i < var_names.size(); ++var_i)
        {
          // Getting the corresponding DoF indices for the variable.
          nl.setVariableGlobalDoFs(var_names[var_i]);
          const std::vector<dof_id_type> & var_dofs = nl.getVariableGlobalDoFs();
 
          // Initializing a temporary vector for the partial solution.
          std::shared_ptr<DenseVector<Real>> tmp = std::make_shared<DenseVector<Real>>();
          solution.localize(tmp->get_values(), var_dofs);
 
          // Copying the temporary vector into the trainer.
          _trainer.addSnapshot(var_i, _global_index, tmp);
        }
      }
    }
  }
}

◆ executeToMultiapp()

void PODSamplerSolutionTransfer::executeToMultiapp ( )

overridevirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 193 of file PODSamplerSolutionTransfer.C.

{
  if (!_pod_multi_app->snapshotGeneration())
  {
    const std::vector<std::string> & var_names = _trainer.getVarNames();
    dof_id_type var_i = _trainer.getVariableIndex(_global_index);
 
    // Getting the reference to the solution vector in the subapp.
    FEProblemBase & app_problem = getToMultiApp()->appProblemBase(processor_id());
    NonlinearSystemBase & nl = app_problem.getNonlinearSystemBase(/*nl_sys_num=*/0);
    NumericVector<Number> & solution = nl.solution();
 
    // Zeroing the solution to make sure that only the required part
    // is non-zero after copy.
    solution.zero();
 
    // Getting the degrees of freedom for the given variable.
    nl.setVariableGlobalDoFs(var_names[var_i]);
    const std::vector<dof_id_type> & var_dofs = nl.getVariableGlobalDoFs();
 
    // Fetching the basis vector and plugging it into the solution.
    const DenseVector<Real> & base_vector = _trainer.getBasisVector(_global_index);
    solution.insert(base_vector, var_dofs);
    solution.close();
 
    // Make sure that the sub-application uses this vector to evaluate the
    // residual.
    nl.setSolution(solution);
  }
}

◆ finalizeFromMultiapp()

void PODSamplerSolutionTransfer::finalizeFromMultiapp ( )

overridevirtual

Reimplemented from StochasticToolsTransfer.

Reimplemented in PODResidualTransfer.

Definition at line 183 of file PODSamplerSolutionTransfer.C.

184{

185}

◆ finalizeToMultiapp()

void PODSamplerSolutionTransfer::finalizeToMultiapp ( )

overridevirtual

Reimplemented from StochasticToolsTransfer.

Definition at line 225 of file PODSamplerSolutionTransfer.C.

226{

227}

◆ getSurrogateModel() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateModel ( const std::string & name ) const

inherited

Get a SurrogateModel/Trainer with a given name.

Parameters

name	The name of the parameter key of the sampler to retrieve

Returns: The sampler with name associated with the parameter 'name'

Definition at line 81 of file SurrogateModelInterface.h.

{
  return getSurrogateModelByName<T>(_smi_params.get<UserObjectName>(name));
}

Referenced by SurrogateTrainer::initialize().

◆ getSurrogateModel() [2/2]

template<>

SurrogateModel & SurrogateModelInterface::getSurrogateModel ( const std::string & name ) const

inherited

Definition at line 46 of file SurrogateModelInterface.C.

{
  return getSurrogateModelByName<SurrogateModel>(_smi_params.get<UserObjectName>(name));
}

◆ getSurrogateModelByName() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName & name ) const

inherited

Get a sampler with a given name.

Parameters

name	The name of the sampler to retrieve

Returns: The sampler with name 'name'

Definition at line 88 of file SurrogateModelInterface.h.

{
  std::vector<T *> models;
  _smi_feproblem.theWarehouse()
      .query()
      .condition<AttribName>(name)
      .condition<AttribSystem>("SurrogateModel")
      .queryInto(models);
  if (models.empty())
    mooseError("Unable to find a SurrogateModel object of type " + std::string(typeid(T).name()) +
               " with the name '" + name + "'");
  return *(models[0]);
}

Referenced by CrossValidationScores::CrossValidationScores(), EvaluateSurrogate::EvaluateSurrogate(), and InverseMapping::initialSetup().

◆ getSurrogateModelByName() [2/2]

template<>

SurrogateModel & SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName & name ) const

inherited

Definition at line 31 of file SurrogateModelInterface.C.

{
  std::vector<SurrogateModel *> models;
  _smi_feproblem.theWarehouse()
      .query()
      .condition<AttribName>(name)
      .condition<AttribSystem>("SurrogateModel")
      .queryInto(models);
  if (models.empty())
    mooseError("Unable to find a SurrogateModel object with the name '" + name + "'");
  return *(models[0]);
}

◆ getSurrogateTrainer() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateTrainer ( const std::string & name ) const

inherited

Definition at line 104 of file SurrogateModelInterface.h.

{
  return getSurrogateTrainerByName<T>(_smi_params.get<UserObjectName>(name));
}

◆ getSurrogateTrainer() [2/2]

template<>

SurrogateTrainerBase & SurrogateModelInterface::getSurrogateTrainer ( const std::string & name ) const

inherited

Definition at line 60 of file SurrogateModelInterface.C.

{
  return getSurrogateTrainerByName<SurrogateTrainerBase>(_smi_params.get<UserObjectName>(name));
}

◆ getSurrogateTrainerByName() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateTrainerByName ( const UserObjectName & name ) const

inherited

Definition at line 111 of file SurrogateModelInterface.h.

{
  SurrogateTrainerBase * base_ptr =
      &_smi_feproblem.getUserObject<SurrogateTrainerBase>(name, _smi_tid);
  T * obj_ptr = dynamic_cast<T *>(base_ptr);
  if (!obj_ptr)
    mooseError("Failed to find a SurrogateTrainer object of type " + std::string(typeid(T).name()) +
                   " with the name '",
               name,
               "' for the desired type.");
  return *obj_ptr;
}

Referenced by SurrogateTrainerOutput::output().

◆ getSurrogateTrainerByName() [2/2]

template<>

SurrogateTrainerBase & SurrogateModelInterface::getSurrogateTrainerByName ( const UserObjectName & name ) const

inherited

Definition at line 53 of file SurrogateModelInterface.C.

{
  return _smi_feproblem.getUserObject<SurrogateTrainerBase>(name);
}

◆ initializeFromMultiapp()

void PODSamplerSolutionTransfer::initializeFromMultiapp ( )

overridevirtual

Methods used when running in batch mode (see SamplerFullSolveMultiApp)

Reimplemented from StochasticToolsTransfer.

Reimplemented in PODResidualTransfer.

Definition at line 140 of file PODSamplerSolutionTransfer.C.

141{

142}

◆ initializeToMultiapp()

void PODSamplerSolutionTransfer::initializeToMultiapp ( )

overridevirtual

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

Reimplemented from StochasticToolsTransfer.

Definition at line 188 of file PODSamplerSolutionTransfer.C.

189{

190}

◆ initialSetup()

void PODSamplerSolutionTransfer::initialSetup ( )

overridevirtual

Reimplemented from MultiAppTransfer.

Definition at line 42 of file PODSamplerSolutionTransfer.C.

{
  const auto multi_app = hasFromMultiApp() ? getFromMultiApp() : getToMultiApp();
 
  // Checking if the subapplication has the requested variables
  const std::vector<std::string> & var_names = _trainer.getVarNames();
  const dof_id_type n = multi_app->numGlobalApps();
  for (MooseIndex(n) i = 0; i < n; i++)
  {
    if (multi_app->hasLocalApp(i))
      for (auto var_name : var_names)
        if (!multi_app->appProblemBase(i).hasVariable(var_name))
          mooseError("Variable '" + var_name + "' not found on sub-application ", i, "!");
  }
}

◆ setCurrentRow()

void StochasticToolsTransfer::setCurrentRow ( const std::vector< Real > & row )

inlineinherited

Method for keeping track of the row data when running in batch mode.

See StochasticTools<FullSolve/Transient>MultiApp

Definition at line 65 of file StochasticToolsTransfer.h.

65{ _row_data = row; }

StochasticToolsTransfer::_row_data

std::vector< Real > _row_data

The current row of data (comes from multiapp)

Definition StochasticToolsTransfer.h:73

◆ setGlobalMultiAppIndex()

void StochasticToolsTransfer::setGlobalMultiAppIndex ( dof_id_type index )

inlineinherited

Method for setting the app index when running in batch mode.

See StochasticTools<FullSolve/Transient>MultiApp

Definition at line 51 of file StochasticToolsTransfer.h.

51{ _app_index = index; }

StochasticToolsTransfer::_app_index

dof_id_type _app_index

Index for the sub-app that the batch-mode multiapp is working on.

Definition StochasticToolsTransfer.h:69

◆ setGlobalRowIndex()

void StochasticToolsTransfer::setGlobalRowIndex ( dof_id_type row )

inlineinherited

Method for keeping track of the global row index when running in batch mode.

See StochasticTools<FullSolve/Transient>MultiApp

Definition at line 58 of file StochasticToolsTransfer.h.

58{ _global_index = row; }

◆ validParams()

InputParameters PODSamplerSolutionTransfer::validParams ( )

static

Definition at line 18 of file PODSamplerSolutionTransfer.C.

{
  InputParameters params = StochasticToolsTransfer::validParams();
  params.addClassDescription("Transfers solution vectors from the sub-applications to a "
                             "a container in the Trainer object and back.");
  params.addRequiredParam<UserObjectName>("trainer_name",
                                          "Trainer object that contains the solutions"
                                          " for different samples.");
  return params;
}

Referenced by PODResidualTransfer::validParams().

Member Data Documentation

◆ _app_index

dof_id_type StochasticToolsTransfer::_app_index = 0

protectedinherited

Index for the sub-app that the batch-mode multiapp is working on.

Definition at line 69 of file StochasticToolsTransfer.h.

Referenced by SerializedSolutionTransfer::executeFromMultiapp(), SamplerParameterTransfer::executeToMultiapp(), SerializedSolutionTransfer::initializeInBatchMode(), and StochasticToolsTransfer::setGlobalMultiAppIndex().

◆ _global_index

dof_id_type StochasticToolsTransfer::_global_index = 0

protectedinherited

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

Definition at line 71 of file StochasticToolsTransfer.h.

Referenced by PODResidualTransfer::executeFromMultiapp(), executeFromMultiapp(), SamplerReporterTransfer::executeFromMultiapp(), SerializedSolutionTransfer::executeFromMultiapp(), executeToMultiapp(), and StochasticToolsTransfer::setGlobalRowIndex().

◆ _pod_multi_app

std::shared_ptr<PODFullSolveMultiApp> PODSamplerSolutionTransfer::_pod_multi_app

protected

The input multiapp casted into a PODFullSolveMultiapp to get access to the specific pod attributes.

Used in batch mode only and checking if the correct MultiApp type has been provided.

Definition at line 50 of file PODSamplerSolutionTransfer.h.

Referenced by executeFromMultiapp(), executeToMultiapp(), and PODSamplerSolutionTransfer().

◆ _row_data

std::vector<Real> StochasticToolsTransfer::_row_data

protectedinherited

The current row of data (comes from multiapp)

Definition at line 73 of file StochasticToolsTransfer.h.

Referenced by SamplerParameterTransfer::executeToMultiapp(), and StochasticToolsTransfer::setCurrentRow().

◆ _sampler_ptr

Sampler* StochasticToolsTransfer::_sampler_ptr

protectedinherited

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

Definition at line 76 of file StochasticToolsTransfer.h.

Referenced by execute(), SamplerParameterTransfer::execute(), SamplerPostprocessorTransfer::execute(), SamplerReporterTransfer::execute(), SerializedSolutionTransfer::execute(), SamplerPostprocessorTransfer::initializeFromMultiapp(), SamplerReporterTransfer::intitializeStochasticReporters(), StochasticToolsTransfer::StochasticToolsTransfer(), SerializedSolutionTransfer::transferInParallel(), and SamplerReporterTransfer::transferStochasticReporters().

◆ _smi_feproblem

FEProblemBase& SurrogateModelInterface::_smi_feproblem

privateinherited

Reference to FEProblemBase instance.

Definition at line 73 of file SurrogateModelInterface.h.

Referenced by SurrogateModelInterface::getSurrogateModelByName(), and SurrogateModelInterface::getSurrogateTrainerByName().

◆ _smi_params

const InputParameters& SurrogateModelInterface::_smi_params

privateinherited

Parameters of the object with this interface.

Definition at line 70 of file SurrogateModelInterface.h.

Referenced by SurrogateModelInterface::getSurrogateModel(), and SurrogateModelInterface::getSurrogateTrainer().

◆ _smi_tid

const THREAD_ID SurrogateModelInterface::_smi_tid

privateinherited

Thread ID.

Definition at line 76 of file SurrogateModelInterface.h.

Referenced by SurrogateModelInterface::getSurrogateTrainerByName().

◆ _trainer

PODReducedBasisTrainer& PODSamplerSolutionTransfer::_trainer

protected

The trainer object to save the solution vector into or to fetch the artificial solution vectors from.

Definition at line 56 of file PODSamplerSolutionTransfer.h.

Referenced by PODResidualTransfer::execute(), execute(), executeFromMultiapp(), executeToMultiapp(), initialSetup(), and PODResidualTransfer::transferResidual().

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

stochastic_tools/include/transfers/PODSamplerSolutionTransfer.h
stochastic_tools/src/transfers/PODSamplerSolutionTransfer.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

◆ PODSamplerSolutionTransfer()

Member Function Documentation

◆ execute()

◆ executeFromMultiapp()

◆ executeToMultiapp()

◆ finalizeFromMultiapp()

◆ finalizeToMultiapp()

◆ getSurrogateModel() [1/2]

◆ getSurrogateModel() [2/2]

◆ getSurrogateModelByName() [1/2]

◆ getSurrogateModelByName() [2/2]

◆ getSurrogateTrainer() [1/2]

◆ getSurrogateTrainer() [2/2]

◆ getSurrogateTrainerByName() [1/2]

◆ getSurrogateTrainerByName() [2/2]

◆ initializeFromMultiapp()

◆ initializeToMultiapp()

◆ initialSetup()

◆ setCurrentRow()

◆ setGlobalMultiAppIndex()

◆ setGlobalRowIndex()

◆ validParams()

Member Data Documentation

◆ _app_index

◆ _global_index

◆ _pod_multi_app

◆ _row_data

◆ _sampler_ptr

◆ _smi_feproblem

◆ _smi_params

◆ _smi_tid

◆ _trainer