www.mooseframework.org
SamplerInterface.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 SAMPLERINTERFACE_H
16 #define SAMPLERINTERFACE_H
17 
18 #include "ParallelUniqueId.h"
19 #include "InputParameters.h"
20 #include "FEProblemBase.h"
21 
22 // Forward declarations
23 class Sampler;
24 class SamplerInterface;
25 
26 template <>
28 
36 {
37 public:
44  SamplerInterface(const MooseObject * moose_object);
45 
51  Sampler & getSampler(const std::string & name);
52 
58  Sampler & getSamplerByName(const SamplerName & name);
59 
60 private:
63 
66 
69 };
70 
71 #endif /* SAMPLERINTERFACE_H */
Sampler & getSampler(const std::string &name)
Get a sampler with a given name.
This is the base class for Samplers.
Definition: Sampler.h:46
Interface for objects that need to use samplers.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
FEProblemBase & _smi_feproblem
Reference to FEProblemBase instance.
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:36
InputParameters validParams< SamplerInterface >()
const InputParameters & _smi_params
Parameters of the object with this interface.
THREAD_ID _smi_tid
Thread ID.
SamplerInterface(const MooseObject *moose_object)
unsigned int THREAD_ID
Definition: MooseTypes.h:79
Sampler & getSamplerByName(const SamplerName &name)
Get a sampler with a given name.