https://mooseframework.inl.gov
Loading...
Searching...
No Matches
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 | List of all members
SamplerParameterTransfer Class Reference

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

#include <SamplerParameterTransfer.h>

Inheritance diagram for SamplerParameterTransfer:
[legend]

Public Types

enum  DIRECTION
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 SamplerParameterTransfer (const InputParameters &parameters)
 
virtual void execute () override
 Traditional Transfer callback.
 
virtual void executeToMultiapp () override
 Methods used when running in batch mode (see SamplerFullSolveMultiApp)
 
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
 
void initialSetup () override
 
const std::shared_ptr< MultiAppgetMultiApp () const
 
const std::shared_ptr< MultiAppgetFromMultiApp () const
 
const std::shared_ptr< MultiAppgetToMultiApp () const
 
std::string getFromName () const
 
std::string getToName () const
 
bool hasFromMultiApp () const
 
bool hasToMultiApp () const
 
virtual void getAppInfo ()
 
const MultiMooseEnumdirections ()
 
void setCurrentDirection (const int direction)
 
virtual bool enabled () const
 
std::shared_ptr< MooseObjectgetSharedPtr ()
 
std::shared_ptr< const MooseObjectgetSharedPtr () const
 
bool isKokkosObject () const
 
MooseAppgetMooseApp () 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 InputParametersparameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const TgetParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const TqueryParam (const std::string &name) const
 
const TgetRenamedParam (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 ExecFlagEnumgetExecuteOnEnum () const
 
PerfGraphperfGraph ()
 
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 ()
 Methods for transferring data from sub-applications to the master application.
 
virtual void executeFromMultiapp ()
 
virtual void finalizeFromMultiapp ()
 
virtual void initializeToMultiapp ()
 Methods for transferring data to sub-applications to the master application.
 
virtual void finalizeToMultiapp ()
 

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::Systemfind_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::map< SamplerReceiver *, std::map< std::string, std::vector< Real > > > getReceivers (unsigned int app_index, const std::vector< std::string > &args)
 Based on command line args, return a map between SamplerReceiver objects and the parameter-value pairs.
 
std::vector< unsigned intgetFromsPerProc ()
 
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
 
TdeclareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< TdeclareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const TgetRestartableData (const std::string &data_name) const
 
TdeclareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
TdeclareRecoverableData (const std::string &data_name, Args &&... args)
 
TdeclareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
TdeclareRestartableDataWithObjectNameWithContext (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::BoundingBoxgetFromBoundingBoxes ()
 
std::vector< libMesh::BoundingBoxgetFromBoundingBoxes (BoundaryID boundary_id)
 
std::vector< libMesh::BoundingBoxgetFromBoundingBoxes ()
 
std::vector< libMesh::BoundingBoxgetFromBoundingBoxes (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

const std::vector< std::string > & _parameter_names
 Storage for the list of parameters to control.
 
dof_id_type _global_index
 Current global index for batch execution.
 
dof_id_type _app_index = 0
 Index for the sub-app that the batch-mode multiapp is working on.
 
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 ()
 
RestartableDataValueregisterRestartableDataOnApp (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
 
TgetSampler (const std::string &name)
 
SamplergetSampler (const std::string &name)
 
TgetSamplerByName (const SamplerName &name)
 
SamplergetSamplerByName (const SamplerName &name)
 

Static Private Member Functions

static std::vector< FEProblemBase * > getMultiAppProblemsHelper (FEProblemBase &base_problem, const std::vector< std::string > &multiapp_names)
 Helper function that recursively finds feproblem pointers from nested multiapps.
 
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
 

Detailed Description

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

Definition at line 21 of file SamplerParameterTransfer.h.

Constructor & Destructor Documentation

◆ SamplerParameterTransfer()

SamplerParameterTransfer::SamplerParameterTransfer ( const InputParameters parameters)

Definition at line 44 of file SamplerParameterTransfer.C.

46 _parameter_names(getParam<std::vector<std::string>>("parameters"))
47{
48 if (hasFromMultiApp())
49 paramError("from_multi_app", "From and between multiapp directions are not implemented");
50}
const InputParameters & parameters() const
void paramError(const std::string &param, Args... args) const
const T & getParam(const std::string &name) const
bool hasFromMultiApp() const
const std::vector< std::string > & _parameter_names
Storage for the list of parameters to control.
The class creates an additional API to allow Transfers to work when running the StochasticTools<FullS...

Member Function Documentation

◆ execute()

void SamplerParameterTransfer::execute ( )
overridevirtual

Traditional Transfer callback.

Implements MultiAppTransfer.

Definition at line 53 of file SamplerParameterTransfer.C.

54{
55 mooseAssert((_sampler_ptr->getNumberOfLocalRows() == 0) ||
56 (_sampler_ptr->getNumberOfLocalRows() == getToMultiApp()->numLocalApps()),
57 "The number of MultiApps and the number of sample rows must be the same.");
58
59 // Loop over all sub-apps
60 for (dof_id_type row_index = _sampler_ptr->getLocalRowBegin();
61 row_index < _sampler_ptr->getLocalRowEnd();
62 row_index++)
63 {
64 mooseAssert(getToMultiApp()->hasLocalApp(row_index),
65 "The current sample row index is not a valid global MultiApp index.");
66
67 // Populate the row of data to transfer
68 std::vector<Real> row = _sampler_ptr->getNextLocalRow();
69
70 // Get the command line arguments
72
73 // Get the sub-app SamplerReceiver objects and transfer param-values map
74 for (auto & ptr : getReceivers(row_index, args))
75 ptr.first->transfer(ptr.second);
76 }
77}
const std::shared_ptr< MultiApp > getToMultiApp() const
static std::vector< std::string > sampledCommandLineArgs(const std::vector< Real > &row, const std::vector< std::string > &full_args_name)
Helper for inserting row data into commandline arguments Used here and in SamplerTransientMultiApp.
std::map< SamplerReceiver *, std::map< std::string, std::vector< Real > > > getReceivers(unsigned int app_index, const std::vector< std::string > &args)
Based on command line args, return a map between SamplerReceiver objects and the parameter-value pair...
std::vector< Real > getNextLocalRow()
dof_id_type getNumberOfLocalRows() const
dof_id_type getLocalRowEnd() const
dof_id_type getLocalRowBegin() const
Sampler * _sampler_ptr
Pointer to the Sampler object used by the SamplerTransientMultiApp or SamplerFullSolveMultiApp.

◆ executeFromMultiapp()

void StochasticToolsTransfer::executeFromMultiapp ( )
virtualinherited

◆ executeToMultiapp()

void SamplerParameterTransfer::executeToMultiapp ( )
overridevirtual

Methods used when running in batch mode (see SamplerFullSolveMultiApp)

Reimplemented from StochasticToolsTransfer.

Definition at line 80 of file SamplerParameterTransfer.C.

81{
82 if (getToMultiApp()->isRootProcessor())
83 {
84 // Get the command line arguments
86
87 // Get the sub-app SamplerReceiver objects and transfer param-values map
88 for (auto & ptr : getReceivers(_app_index, args))
89 ptr.first->transfer(ptr.second);
90 }
91}
std::vector< Real > _row_data
The current row of data (comes from multiapp)
dof_id_type _app_index
Index for the sub-app that the batch-mode multiapp is working on.

◆ finalizeFromMultiapp()

void StochasticToolsTransfer::finalizeFromMultiapp ( )
virtualinherited

◆ finalizeToMultiapp()

void StochasticToolsTransfer::finalizeToMultiapp ( )
virtualinherited

Reimplemented in PODSamplerSolutionTransfer, and SerializedSolutionTransfer.

Definition at line 136 of file StochasticToolsTransfer.C.

137{
138}

◆ getMultiAppProblemsHelper()

std::vector< FEProblemBase * > SamplerParameterTransfer::getMultiAppProblemsHelper ( FEProblemBase base_problem,
const std::vector< std::string > &  multiapp_names 
)
staticprivate

Helper function that recursively finds feproblem pointers from nested multiapps.

Definition at line 164 of file SamplerParameterTransfer.C.

166{
167 // This is what we'll return
168 std::vector<FEProblemBase *> problems;
169
170 if (multiapp_names.empty()) // Stop recursion if no nested apps provided
171 problems.push_back(&base_problem);
172 else
173 {
174 // Get the name of highest level app provided and the index if provided
175 std::string sub_name;
176 int sub_num = -1;
177 pcrecpp::RE("(\\S*?)(\\d*)").FullMatch(multiapp_names[0], &sub_name, &sub_num);
178 MultiApp & multiapp = *base_problem.getMultiApp(sub_name);
179
180 // Get the app indices (either the requested one or all of them)
181 std::pair<unsigned int, unsigned int> app_ind;
182 if (sub_num == -1) // There was no number provided, so get all the local sub apps
183 app_ind = std::make_pair(multiapp.firstLocalApp(),
184 multiapp.firstLocalApp() + multiapp.numLocalApps());
185 else if (multiapp.hasLocalApp(sub_num)) // Number provided, get that app if owned
186 app_ind = std::make_pair(sub_num, sub_num + 1);
187 else // This processor doesn't own the app index provided
188 return {};
189
190 // Get all the nested subapps with recursion
191 std::vector<std::string> nested_names(multiapp_names.begin() + 1, multiapp_names.end());
192 for (unsigned int i = app_ind.first; i < app_ind.second; ++i)
193 for (auto & prob : getMultiAppProblemsHelper(multiapp.appProblemBase(i), nested_names))
194 problems.push_back(prob);
195 }
196
197 return problems;
198}
std::shared_ptr< MultiApp > getMultiApp(const std::string &multi_app_name) const
unsigned int numLocalApps()
bool hasLocalApp(unsigned int global_app) const
unsigned int firstLocalApp()
static std::vector< FEProblemBase * > getMultiAppProblemsHelper(FEProblemBase &base_problem, const std::vector< std::string > &multiapp_names)
Helper function that recursively finds feproblem pointers from nested multiapps.

Referenced by getMultiAppProblemsHelper(), and getReceivers().

◆ getReceivers()

std::map< SamplerReceiver *, std::map< std::string, std::vector< Real > > > SamplerParameterTransfer::getReceivers ( unsigned int  app_index,
const std::vector< std::string > &  args 
)
protected

Based on command line args, return a map between SamplerReceiver objects and the parameter-value pairs.

Parameters
app_indexThe global sup-app index
argsThe command line args
Returns
A map between the SamplerReceiver object and the parameter-value pairs

Definition at line 94 of file SamplerParameterTransfer.C.

96{
97 // These are the receivers we are returning
98 std::map<SamplerReceiver *, std::map<std::string, std::vector<Real>>> ptrs;
99
100 // Split all the input parameters to retrieve receivers and set param-values pairs
101 // Cache the multiapp-reciever mapping
102 std::unordered_map<std::string, std::vector<SamplerReceiver *>> multiapp_receivers;
103 for (const auto & param : args)
104 {
105 // Get MultiApp Name
106 std::string multiapp_name = getToMultiApp()->name();
107 const auto pos = param.rfind(":");
108 if (pos != std::string::npos)
109 multiapp_name += ":" + param.substr(0, pos);
110 // Get parameter name
111 const auto pos2 = param.rfind("=");
112 if (pos2 == std::string::npos)
113 mooseError("Internal error: Improper command-line format\n ", param, ".");
114 const std::string param_name = param.substr(pos + 1, pos2 - pos - 1);
115
116 // Get values
117 const std::string vstr = param.substr(pos2 + 1);
118 const auto vpos1 = vstr.find("'");
119 const auto vpos2 = vstr.rfind("'");
120 std::vector<Real> value;
121 if (!MooseUtils::tokenizeAndConvert(vstr.substr(vpos1 + 1, vpos2 - vpos1 - 1), value, " "))
122 mooseError("Internal error: Improper command-line format\n ", param, ".");
123
124 // Find receivers if we haven't already found them
125 if (multiapp_receivers.find(multiapp_name) == multiapp_receivers.end())
126 {
127 auto & recvs = multiapp_receivers[multiapp_name]; // Convenience
128 // Split the <sub>:<subsub>:<subsubsub> syntax
129 const std::vector<std::string> nested_names = MooseUtils::split(multiapp_name, ":");
130 // Find all the appropriate FEProblemBases based on the parameter syntax and get a
131 // SamplerReceiver
132 for (const auto & problem : getMultiAppProblemsHelper(
133 getToMultiApp()->appProblemBase(app_index),
134 std::vector<std::string>(nested_names.begin() + 1, nested_names.end())))
135 {
136 // Loop through all the active controls and find one that is a SamplerReciever
137 SamplerReceiver * recv_ptr = nullptr;
138 for (const auto & control_ptr : problem->getControlWarehouse().getActiveObjects())
139 {
140 recv_ptr = dynamic_cast<SamplerReceiver *>(control_ptr.get());
141 if (recv_ptr)
142 break;
143 }
144 if (!recv_ptr)
145 paramError("parameters",
146 "The sub-application (",
147 multiapp_name,
148 ") does not contain a SamplerReceiver control object.");
149
150 // Insert the found receiver
151 recvs.push_back(recv_ptr);
152 }
153 }
154
155 // Add the parameter and value to the reciever map
156 for (const auto & recv_ptr : multiapp_receivers[multiapp_name])
157 ptrs[recv_ptr][param_name] = value;
158 }
159
160 return ptrs;
161}
void mooseError(Args &&... args) const
A Control object for receiving data from a master application Sampler object.
bool tokenizeAndConvert(const std::string &str, std::vector< T > &tokenized_vector, const std::string &delimiter=" \t\n\v\f\r")
std::vector< std::string > split(const std::string &str, const std::string &delimiter, std::size_t max_count)
Real value(unsigned n, unsigned alpha, unsigned beta, Real x)

Referenced by execute(), and executeToMultiapp().

◆ initializeFromMultiapp()

void StochasticToolsTransfer::initializeFromMultiapp ( )
virtualinherited

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

Reimplemented in PODResidualTransfer, PODSamplerSolutionTransfer, SamplerPostprocessorTransfer, SamplerReporterTransfer, and SerializedSolutionTransfer.

Definition at line 111 of file StochasticToolsTransfer.C.

112{
113}

◆ initializeToMultiapp()

void StochasticToolsTransfer::initializeToMultiapp ( )
virtualinherited

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

Reimplemented in PODSamplerSolutionTransfer, and SerializedSolutionTransfer.

Definition at line 126 of file StochasticToolsTransfer.C.

127{
128}

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

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

◆ 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; }
dof_id_type _global_index
Index for tracking the row index when using batch mode operation.

◆ validParams()

InputParameters SamplerParameterTransfer::validParams ( )
static

Definition at line 26 of file SamplerParameterTransfer.C.

27{
29 params.addClassDescription("Copies Sampler data to a SamplerReceiver object.");
30 params.suppressParameter<MultiMooseEnum>("direction");
31 params.suppressParameter<MultiAppName>("multi_app");
32 params.addParam<std::vector<std::string>>(
33 "parameters",
34 "A list of parameters (on the sub application) to control "
35 "with the Sampler data. The order of the parameters listed "
36 "here should match the order of the items in the Sampler.");
37 params.addDeprecatedParam<std::string>(
38 "to_control",
39 "Unused parameter.",
40 "This parameter is no longer used as the SamplerReceiver will automatically be detected.");
41 return params;
42}
void suppressParameter(const std::string &name)
void addDeprecatedParam(const std::string &name, const T &value, const std::string &doc_string, const std::string &deprecation_message)
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addClassDescription(const std::string &doc_string)
static InputParameters validParams()

Member Data Documentation

◆ _app_index

dof_id_type StochasticToolsTransfer::_app_index = 0
protectedinherited

◆ _global_index

dof_id_type SamplerParameterTransfer::_global_index
protected

Current global index for batch execution.

Definition at line 53 of file SamplerParameterTransfer.h.

◆ _parameter_names

const std::vector<std::string>& SamplerParameterTransfer::_parameter_names
protected

Storage for the list of parameters to control.

Definition at line 50 of file SamplerParameterTransfer.h.

Referenced by execute(), and executeToMultiapp().

◆ _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 executeToMultiapp(), and StochasticToolsTransfer::setCurrentRow().

◆ _sampler_ptr

Sampler* StochasticToolsTransfer::_sampler_ptr
protectedinherited

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