SamplerInterface Class Reference

Interface for objects that need to use samplers. More...

#include <SamplerInterface.h>

Inheritance diagram for SamplerInterface:

Public Member Functions
	SamplerInterface (const MooseObject *moose_object)
template<typename T = Sampler>
T &	getSampler (const std::string &name)
	Get a sampler with a given name. More...
template<typename T = Sampler>
T &	getSamplerByName (const SamplerName &name)
	Get a sampler with a given name. More...
template<>
Sampler &	getSampler (const std::string &name)
template<>
Sampler &	getSamplerByName (const SamplerName &name)

Static Public Member Functions
static InputParameters	validParams ()

Private Attributes
const InputParameters &	_si_params
	Parameters of the object with this interface. More...
FEProblemBase &	_si_feproblem
	Reference to FEProblemBase instance. More...
THREAD_ID	_si_tid
	Thread ID. More...

Detailed Description

Interface for objects that need to use samplers.

This practically adds two methods for getting Sampler objects:

1. Call getSampler or getSamplerByName without a template parameter and you will get a Sampler base object (see SamplerInterface.C for the template specialization).
2. Call getSampler<MySampler> or getSamplerByName<MySampler> to perform a cast to the desired type, as done for UserObjects.

Definition at line 28 of file SamplerInterface.h.

Constructor & Destructor Documentation

SamplerInterface()

SamplerInterface::SamplerInterface

(

const MooseObject *

moose_object

)

Parameters

params

The parameters used by the object being instantiated. This class needs them so it can get the sampler named in the input file, but the object calling getSampler only needs to use the name on the left hand side of the statement "sampler = sampler_name"

Definition at line 21 of file SamplerInterface.C.

  : _si_params(moose_object->parameters()),
    _si_feproblem(*_si_params.get<FEProblemBase *>("_fe_problem_base")),
    _si_tid(_si_params.have_parameter<THREAD_ID>("_tid") ? _si_params.get<THREAD_ID>("_tid") : 0)
{
}

Member Function Documentation

getSampler() [1/2]

template<>

Sampler& SamplerInterface::getSampler

(

const std::string &

name

)

Definition at line 30 of file SamplerInterface.C.

{
  return _si_feproblem.getSampler(_si_params.get<SamplerName>(name));
}

getSampler() [2/2]

template<typename T >

T & SamplerInterface::getSampler

(

const std::string &

name

)

Get a sampler with a given name.

Parameters

name	The name of the parameter key of the sampler to retrieve

Returns

The sampler with name associated with the parameter 'name'

Definition at line 70 of file SamplerInterface.h.

{
  return getSamplerByName<T>(_si_params.get<SamplerName>(name));
}

getSamplerByName() [1/2]

template<>

Sampler& SamplerInterface::getSamplerByName

(

const SamplerName &

name

)

Definition at line 37 of file SamplerInterface.C.

{
  return _si_feproblem.getSampler(name, _si_tid);
}

getSamplerByName() [2/2]

template<typename T >

T & SamplerInterface::getSamplerByName

(

const SamplerName &

name

)

Get a sampler with a given name.

Parameters

name	The name of the sampler to retrieve

Returns

The sampler with name 'name'

Definition at line 77 of file SamplerInterface.h.

{
  Sampler * base_ptr = &_si_feproblem.getSampler(name, _si_tid);
  T * obj_ptr = dynamic_cast<T *>(base_ptr);
  if (!obj_ptr)
    mooseError("Failed to find a Sampler object with the name '", name, "' for the desired type.");
  return *obj_ptr;
}

validParams()

InputParameters SamplerInterface::validParams ( )

static

Definition at line 16 of file SamplerInterface.C.

{
  return emptyInputParameters();
}

Member Data Documentation

_si_feproblem

FEProblemBase& SamplerInterface::_si_feproblem

private

Reference to FEProblemBase instance.

Definition at line 62 of file SamplerInterface.h.

Referenced by getSampler(), and getSamplerByName().

_si_params

const InputParameters& SamplerInterface::_si_params

private

Parameters of the object with this interface.

Definition at line 59 of file SamplerInterface.h.

Referenced by getSampler().

_si_tid

THREAD_ID SamplerInterface::_si_tid

private

Thread ID.

Definition at line 65 of file SamplerInterface.h.

Referenced by getSamplerByName().

---

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

• include/samplers/SamplerInterface.h
• src/samplers/SamplerInterface.C