Interface for objects that need to use distributions. More...
#include <DistributionInterface.h>
Public Member Functions | |
DistributionInterface (const MooseObject *moose_object) | |
const Distribution & | getDistribution (const std::string &name) const |
Get a distribution with a given name. More... | |
template<typename T > | |
const T & | getDistribution (const std::string &name) const |
const Distribution & | getDistributionByName (const DistributionName &name) const |
Get a distribution with a given name. More... | |
template<typename T > | |
const T & | getDistributionByName (const std::string &name) const |
Static Public Member Functions | |
static InputParameters | validParams () |
Private Attributes | |
const InputParameters & | _dni_params |
Parameters of the object with this interface. More... | |
FEProblemBase & | _dni_feproblem |
Reference to FEProblemBase instance. More... | |
const MooseObject *const | _dni_moose_object_ptr |
Pointer to the MooseObject. More... | |
Interface for objects that need to use distributions.
Inherit from this class at a very low level to make the getDistribution method available.
Definition at line 25 of file DistributionInterface.h.
DistributionInterface::DistributionInterface | ( | const MooseObject * | moose_object | ) |
Definition at line 23 of file DistributionInterface.C.
const Distribution & DistributionInterface::getDistribution | ( | const std::string & | name | ) | const |
Get a distribution with a given name.
name | The name of the parameter key of the distribution to retrieve |
Definition at line 31 of file DistributionInterface.C.
Referenced by getDistribution(), and getDistributionByName().
const T & DistributionInterface::getDistribution | ( | const std::string & | name | ) | const |
Definition at line 69 of file DistributionInterface.h.
const Distribution & DistributionInterface::getDistributionByName | ( | const DistributionName & | name | ) | const |
Get a distribution with a given name.
name | The name of the distribution to retrieve |
Definition at line 38 of file DistributionInterface.C.
Referenced by RandomIC::RandomIC().
const T & DistributionInterface::getDistributionByName | ( | const std::string & | name | ) | const |
Definition at line 89 of file DistributionInterface.h.
|
static |
Definition at line 17 of file DistributionInterface.C.
Referenced by RandomIC::validParams(), Sampler::validParams(), and FVInterfaceKernel::validParams().
|
private |
Reference to FEProblemBase instance.
Definition at line 61 of file DistributionInterface.h.
Referenced by getDistribution(), and getDistributionByName().
|
private |
Pointer to the MooseObject.
Definition at line 64 of file DistributionInterface.h.
Referenced by getDistribution(), and getDistributionByName().
|
private |
Parameters of the object with this interface.
Definition at line 58 of file DistributionInterface.h.
Referenced by getDistribution().