TestDistributionDirectPostprocessor Class Reference

Test object for testing distribution capabilities. More...

#include <TestDistributionDirectPostprocessor.h>

Inheritance diagram for TestDistributionDirectPostprocessor:

Public Member Functions
	TestDistributionDirectPostprocessor (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 NormalDistribution &	_distribution
	Object of statistics distribution. More...
const Real &	_value
	The value to supply to method. More...
const Real &	_mean
	Value of mean to test direct method. More...
const Real &	_std_dev
	Value of standard deviation to test direct 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 TestDistributionDirectPostprocessor.h.

Constructor & Destructor Documentation

TestDistributionDirectPostprocessor()

TestDistributionDirectPostprocessor::TestDistributionDirectPostprocessor

(

const InputParameters &

parameters

)

Definition at line 32 of file TestDistributionDirectPostprocessor.C.

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

Member Function Documentation

execute()

virtual void TestDistributionDirectPostprocessor::execute ( )

inlineoverridevirtual

Definition at line 32 of file TestDistributionDirectPostprocessor.h.

{}

getValue()

PostprocessorValue TestDistributionDirectPostprocessor::getValue ( )

overridevirtual

Definition at line 44 of file TestDistributionDirectPostprocessor.C.

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

initialize()

virtual void TestDistributionDirectPostprocessor::initialize ( )

inlineoverridevirtual

Definition at line 31 of file TestDistributionDirectPostprocessor.h.

{}

validParams()

InputParameters TestDistributionDirectPostprocessor::validParams ( )

static

Definition at line 18 of file TestDistributionDirectPostprocessor.C.

{
  InputParameters params = GeneralPostprocessor::validParams();
  params.addRequiredParam<DistributionName>(
      "distribution", "The normal 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.");
  params.addParam<Real>("mean", 0, "Mean of normal distribution.");
  params.addParam<Real>("standard_deviation", 1, "Standard deviation of normal distribution.");
  MooseEnum method("cdf pdf quantile");
  params.addParam<MooseEnum>("method", method, "The distribution method to call.");
  return params;
}

Member Data Documentation

_distribution

const NormalDistribution& TestDistributionDirectPostprocessor::_distribution

protected

Object of statistics distribution.

Definition at line 37 of file TestDistributionDirectPostprocessor.h.

Referenced by getValue().

_distribution_method

const MooseEnum& TestDistributionDirectPostprocessor::_distribution_method

protected

The distribution method to call.

Definition at line 49 of file TestDistributionDirectPostprocessor.h.

Referenced by getValue().

_mean

const Real& TestDistributionDirectPostprocessor::_mean

protected

Value of mean to test direct method.

Definition at line 43 of file TestDistributionDirectPostprocessor.h.

Referenced by getValue().

_std_dev

const Real& TestDistributionDirectPostprocessor::_std_dev

protected

Value of standard deviation to test direct method.

Definition at line 46 of file TestDistributionDirectPostprocessor.h.

Referenced by getValue().

_value

const Real& TestDistributionDirectPostprocessor::_value

protected

The value to supply to method.

Definition at line 40 of file TestDistributionDirectPostprocessor.h.

Referenced by getValue().

---

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

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