Transfers residuals for given variables and vector tags from a sub-subapplication to a PODReducedBasisTrainer object. More...

#include <PODResidualTransfer.h>

Inheritance diagram for PODResidualTransfer:

[legend]

Public Types
enum	DIRECTION

typedef DataFileName	DataFileParameterType

Public Member Functions
	PODResidualTransfer (const InputParameters &parameters)

virtual void	initialSetup () override

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

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

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

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

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

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

void	callMooseError (std::string msg, const bool with_prefix) const

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

const InputParameters &	parameters () const

MooseObjectName	uniqueName () 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 &nm) const

void	paramError (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

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

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

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

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

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

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

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

void	mooseInfo (Args &&... args) 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) More...

virtual void	executeFromMultiapp () override

virtual void	finalizeFromMultiapp () override


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

virtual void	executeToMultiapp () override

virtual void	finalizeToMultiapp () override

Static Public Member Functions
static InputParameters	validParams ()

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

const ConsoleStream	_console

Static Public Attributes
static const libMesh::Number	OutOfMeshValue

Protected Member Functions
virtual void	execute () override
	Transfer callback that will transfer residuals with given tags from the subapplication. More...

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	errorIfObjectExecutesOnTransferInSourceApp (const std::string &object_name) const

Point	getPointInTargetAppFrame (const Point &p, unsigned int local_i_to, 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

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	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. More...

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

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

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

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

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

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

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

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
void	transferResidual (dof_id_type base_i, dof_id_type multi_app_i)
	Adds the variable-residuals to the trainer. More...

Detailed Description

Transfers residuals for given variables and vector tags from a sub-subapplication to a PODReducedBasisTrainer object.

Definition at line 19 of file PODResidualTransfer.h.

Constructor & Destructor Documentation

◆ PODResidualTransfer()

PODResidualTransfer::PODResidualTransfer ( const InputParameters & parameters )

Definition at line 27 of file PODResidualTransfer.C.

   : PODSamplerSolutionTransfer(parameters)
 {
   if (hasToMultiApp())
     paramError("to_multi_app", "To and between multiapp directions are not implemented");
 }

Member Function Documentation

◆ execute()

void PODResidualTransfer::execute ( )

overrideprotectedvirtual

Transfer callback that will transfer residuals with given tags from the subapplication.

Reimplemented from PODSamplerSolutionTransfer.

Definition at line 35 of file PODResidualTransfer.C.

 {
   const unsigned int total_base_num = _trainer.getSumBaseSize();
 
   // Looping over sub-apps
   for (unsigned int base_i = 0; base_i < total_base_num; ++base_i)
     if (getFromMultiApp()->hasLocalApp(base_i))
       transferResidual(base_i, base_i);
 }

◆ executeFromMultiapp()

void PODResidualTransfer::executeFromMultiapp ( )

overridevirtual

Reimplemented from PODSamplerSolutionTransfer.

Definition at line 46 of file PODResidualTransfer.C.

 {
   transferResidual(_global_index, processor_id());
 }

◆ executeToMultiapp()

void PODSamplerSolutionTransfer::executeToMultiapp ( )

overridevirtualinherited

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

virtual void PODResidualTransfer::finalizeFromMultiapp ( )

inlineoverridevirtual

Reimplemented from PODSamplerSolutionTransfer.

Definition at line 31 of file PODResidualTransfer.h.

31 {};

◆ finalizeToMultiapp()

void PODSamplerSolutionTransfer::finalizeToMultiapp ( )

overridevirtualinherited

Reimplemented from StochasticToolsTransfer.

Definition at line 225 of file PODSamplerSolutionTransfer.C.

226 {

227 }

◆ initializeFromMultiapp()

virtual void PODResidualTransfer::initializeFromMultiapp ( )

inlineoverridevirtual

Methods used when running in batch mode (see SamplerFullSolveMultiApp)

Reimplemented from PODSamplerSolutionTransfer.

Definition at line 29 of file PODResidualTransfer.h.

29 {};

◆ initializeToMultiapp()

void PODSamplerSolutionTransfer::initializeToMultiapp ( )

overridevirtualinherited

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

overridevirtualinherited

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

StochasticToolsTransfer::_global_index

dof_id_type _global_index

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

Definition: StochasticToolsTransfer.h:71

◆ transferResidual()

void PODResidualTransfer::transferResidual	(	dof_id_type	base_i,
		dof_id_type	multi_app_i
	)

private

Adds the variable-residuals to the trainer.

Definition at line 52 of file PODResidualTransfer.C.

Referenced by execute(), and executeFromMultiapp().

 {
   const std::vector<std::string> & var_names = _trainer.getVarNames();
   const std::vector<std::string> & tag_names = _trainer.getTagNames();
   const std::vector<std::string> & tag_types = _trainer.getTagTypes();
 
   // Getting reference to the non-linear system
   FEProblemBase & app_problem = getFromMultiApp()->appProblemBase(multi_app_i);
   NonlinearSystemBase & nl = app_problem.getNonlinearSystemBase(/*nl_sys_num=*/0);
 
   // Looping over the residual tags and extracting the corresponding vector.
   for (unsigned int tag_i = 0; tag_i < tag_names.size(); ++tag_i)
   {
     // If the tag corresponds to an independent operator, it is enough to
     // transfer it once.
     if (base_i > 0 && (tag_types[tag_i] == "src" || tag_types[tag_i] == "src_dir"))
       continue;
 
     TagID tag_id = app_problem.getVectorTagID(tag_names[tag_i]);
 
     // Fetching the corresponding residual vector and extracting the parts for
     // each variable.
     NumericVector<Number> & full_residual = nl.getVector(tag_id);
     std::vector<DenseVector<Real>> split_residual(var_names.size());
 
     for (unsigned int var_i = 0; var_i < var_names.size(); ++var_i)
     {
       // Getting the DoF indices of the variable.
       nl.setVariableGlobalDoFs(var_names[var_i]);
       const std::vector<dof_id_type> & var_dofs = nl.getVariableGlobalDoFs();
 
       // Extracting the corresponding part of the residual vector.
       full_residual.localize(split_residual[var_i].get_values(), var_dofs);
     }
 
     // Inserting the contribution of this residual into the reduced operator in
     // the trainer.
     _trainer.addToReducedOperator(base_i, tag_i, split_residual);
   }
 }

◆ validParams()

InputParameters PODResidualTransfer::validParams ( )

static

Definition at line 17 of file PODResidualTransfer.C.

 {
   InputParameters params = PODSamplerSolutionTransfer::validParams();
   params.addClassDescription("Transfers residual vectors from the sub-application to a "
                              "a container in the Trainer object.");
   params.suppressParameter<MultiMooseEnum>("direction");
   params.suppressParameter<MultiAppName>("multi_app");
   return params;
 }

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 executeFromMultiapp(), PODSamplerSolutionTransfer::executeFromMultiapp(), SerializedSolutionTransfer::executeFromMultiapp(), SamplerReporterTransfer::executeFromMultiapp(), PODSamplerSolutionTransfer::executeToMultiapp(), and StochasticToolsTransfer::setGlobalRowIndex().

◆ _pod_multi_app

std::shared_ptr<PODFullSolveMultiApp> PODSamplerSolutionTransfer::_pod_multi_app

protectedinherited

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 PODSamplerSolutionTransfer::executeFromMultiapp(), PODSamplerSolutionTransfer::executeToMultiapp(), and PODSamplerSolutionTransfer::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 SamplerParameterTransfer::execute(), PODSamplerSolutionTransfer::execute(), SerializedSolutionTransfer::execute(), SamplerReporterTransfer::execute(), SamplerPostprocessorTransfer::execute(), SamplerPostprocessorTransfer::initializeFromMultiapp(), SamplerReporterTransfer::intitializeStochasticReporters(), StochasticToolsTransfer::StochasticToolsTransfer(), SerializedSolutionTransfer::transferInParallel(), and SamplerReporterTransfer::transferStochasticReporters().

◆ _trainer

PODReducedBasisTrainer& PODSamplerSolutionTransfer::_trainer

protectedinherited

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 PODSamplerSolutionTransfer::execute(), execute(), PODSamplerSolutionTransfer::executeFromMultiapp(), PODSamplerSolutionTransfer::executeToMultiapp(), PODSamplerSolutionTransfer::initialSetup(), and transferResidual().

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

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

Detailed Description

Constructor & Destructor Documentation

◆ PODResidualTransfer()

Member Function Documentation

◆ execute()

◆ executeFromMultiapp()

◆ executeToMultiapp()

◆ finalizeFromMultiapp()

◆ finalizeToMultiapp()

◆ initializeFromMultiapp()

◆ initializeToMultiapp()

◆ initialSetup()

◆ setCurrentRow()

◆ setGlobalMultiAppIndex()

◆ setGlobalRowIndex()

◆ transferResidual()

◆ validParams()

Member Data Documentation

◆ _app_index

◆ _global_index

◆ _pod_multi_app

◆ _row_data

◆ _sampler_ptr

◆ _trainer