www.mooseframework.org
SamplerReceiver.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef SAMPLERRECEIVER_H
16 #define SAMPLERRECEIVER_H
17 
18 // MOOSE includes
19 #include "Control.h"
20 
21 // Forward declarations
22 class SamplerReceiver;
23 class Function;
24 
25 template <>
26 InputParameters validParams<SamplerReceiver>();
27 
31 class SamplerReceiver : public Control
32 {
33 public:
34  SamplerReceiver(const InputParameters & parameters);
35  virtual void execute() override;
36 
37 protected:
41  void reset();
42 
46  void addControlParameter(const std::string & name, const Real & value);
47 
49  std::map<std::string, Real> _parameters;
50 
53  friend class SamplerTransfer;
54 };
55 
56 #endif
InputParameters validParams< SamplerReceiver >()
void addControlParameter(const std::string &name, const Real &value)
Appends the list of parameters to modify.
Copy each row from each DenseMatrix to the sub-applications SamplerReceiver object.
SamplerReceiver(const InputParameters &parameters)
void reset()
Clears the list of parameters to modify.
A Control object for receiving data from a master application Sampler object.
virtual void execute() override
std::map< std::string, Real > _parameters
Storage for the parameters to control.