www.mooseframework.org
SamplerParameterTransfer.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 // MOOSE includes
14 
15 // Forward declarations
16 class SamplerReceiver;
17 
22 {
23 public:
24  static InputParameters validParams();
25 
26  SamplerParameterTransfer(const InputParameters & parameters);
30  virtual void execute() override;
31 
33 
36  virtual void initializeToMultiapp() override;
37  virtual void executeToMultiapp() override;
38  virtual void finalizeToMultiapp() override;
40 
41 protected:
46  SamplerReceiver * getReceiver(unsigned int app_index);
47 
49  const std::vector<std::string> & _parameter_names;
50 
52  const std::string & _receiver_name;
53 
55  dof_id_type _global_index;
56 };
StochasticToolsTransfer
The class creates an additional API to allow Transfers to work when running the StochasticTools<FullS...
Definition: StochasticToolsTransfer.h:24
SamplerParameterTransfer::executeToMultiapp
virtual void executeToMultiapp() override
Definition: SamplerParameterTransfer.C:82
SamplerParameterTransfer::_receiver_name
const std::string & _receiver_name
The name of the SamplerReceiver Control object on the sub-application.
Definition: SamplerParameterTransfer.h:52
SamplerParameterTransfer::_global_index
dof_id_type _global_index
Current global index for batch execution.
Definition: SamplerParameterTransfer.h:55
SamplerParameterTransfer::execute
virtual void execute() override
Traditional Transfer callback.
Definition: SamplerParameterTransfer.C:51
SamplerParameterTransfer
Copy each row from each DenseMatrix to the sub-applications SamplerReceiver object.
Definition: SamplerParameterTransfer.h:21
SamplerReceiver
A Control object for receiving data from a master application Sampler object.
Definition: SamplerReceiver.h:25
StochasticToolsTransfer.h
SamplerParameterTransfer::initializeToMultiapp
virtual void initializeToMultiapp() override
Methods used when running in batch mode (see SamplerFullSolveMultiApp)
Definition: SamplerParameterTransfer.C:76
SamplerParameterTransfer::SamplerParameterTransfer
SamplerParameterTransfer(const InputParameters &parameters)
Definition: SamplerParameterTransfer.C:43
SamplerParameterTransfer::getReceiver
SamplerReceiver * getReceiver(unsigned int app_index)
Return the SamplerReceiver object and perform error checking.
Definition: SamplerParameterTransfer.C:99
SamplerParameterTransfer::finalizeToMultiapp
virtual void finalizeToMultiapp() override
Definition: SamplerParameterTransfer.C:94
SamplerParameterTransfer::validParams
static InputParameters validParams()
Definition: SamplerParameterTransfer.C:26
SamplerParameterTransfer::_parameter_names
const std::vector< std::string > & _parameter_names
Storage for the list of parameters to control.
Definition: SamplerParameterTransfer.h:49