TestDistributionPostprocessor Class Reference

Test object for testing distribution capabilities. More...

#include <TestDistributionPostprocessor.h>

Inheritance diagram for TestDistributionPostprocessor:

Public Member Functions
	TestDistributionPostprocessor (const InputParameters &parameters)
virtual void	initialize () override
virtual void	execute () override
virtual PostprocessorValue	getValue () override

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const Distribution &	_distribution
	Object of statistics distribution. More...
const Real &	_value
	The value to supply to method. More...
const MooseEnum &	_distribution_method
	The distribution method to call. More...

Detailed Description

Test object for testing distribution capabilities.

WARNING! This object is only for testing and should not be used in general.

Definition at line 25 of file TestDistributionPostprocessor.h.

Constructor & Destructor Documentation

TestDistributionPostprocessor()

TestDistributionPostprocessor::TestDistributionPostprocessor

(

const InputParameters &

parameters

)

Definition at line 31 of file TestDistributionPostprocessor.C.

  : GeneralPostprocessor(parameters),
    _distribution(getDistribution("distribution")),
    _value(getParam<Real>("value")),
    _distribution_method(getParam<MooseEnum>("method"))
{
}

Member Function Documentation

execute()

virtual void TestDistributionPostprocessor::execute ( )

inlineoverridevirtual

Definition at line 32 of file TestDistributionPostprocessor.h.

{}

getValue()

PostprocessorValue TestDistributionPostprocessor::getValue ( )

overridevirtual

Definition at line 40 of file TestDistributionPostprocessor.C.

{
  if (_distribution_method == "pdf")
    return _distribution.pdf(_value);
  else if (_distribution_method == "cdf")
    return _distribution.cdf(_value);
  else if (_distribution_method == "quantile")
    return _distribution.quantile(_value);
  mooseError("This should be possible to reach, what did you do!");
}

initialize()

virtual void TestDistributionPostprocessor::initialize ( )

inlineoverridevirtual

Definition at line 31 of file TestDistributionPostprocessor.h.

{}

validParams()

InputParameters TestDistributionPostprocessor::validParams ( )

static

Definition at line 18 of file TestDistributionPostprocessor.C.

{
  InputParameters params = GeneralPostprocessor::validParams();
  params.addRequiredParam<DistributionName>(
      "distribution", "The distribution which supplies the postprocessor value.");
  params.addRequiredParam<Real>(
      "value", "A value to pass to the cdf, pdf, or quantile function of the given distribution.");
 
  MooseEnum method("cdf pdf quantile");
  params.addParam<MooseEnum>("method", method, "The distribution method to call.");
  return params;
}

Member Data Documentation

_distribution

const Distribution& TestDistributionPostprocessor::_distribution

protected

Object of statistics distribution.

Definition at line 37 of file TestDistributionPostprocessor.h.

Referenced by getValue().

_distribution_method

const MooseEnum& TestDistributionPostprocessor::_distribution_method

protected

The distribution method to call.

Definition at line 43 of file TestDistributionPostprocessor.h.

Referenced by getValue().

_value

const Real& TestDistributionPostprocessor::_value

protected

The value to supply to method.

Definition at line 40 of file TestDistributionPostprocessor.h.

Referenced by getValue().

---

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

• stochastic_tools/test/include/utils/TestDistributionPostprocessor.h
• stochastic_tools/test/src/utils/TestDistributionPostprocessor.C