A class used to generate a normal distribution. More...

#include <Maxwellian.h>

Inheritance diagram for Maxwellian:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	Maxwellian (const InputParameters &parameters)

virtual Real	pdf (const Real &x) const override

virtual Real	cdf (const Real &x) const override

virtual Real	quantile (const Real &p) const override

virtual Real	median () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	haveParameter (const std::string &name) const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static Real	pdf (const Real &x, const Real &mass, const Real &temperature)

static Real	cdf (const Real &x, const Real &mass, const Real &temperature)

static Real	quantile (const Real &p, const Real &mass, const Real &temperature)

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

Protected Member Functions
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

Static Protected Member Functions
static Real	standardDeviation (const Real mass, const Real temperature)
	Helper for computing the standard deviation for the equivalent normal distribution. More...

Protected Attributes
const Real	_standard_deviation
	the standard deviation for the equivalent normal distribution More...

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Detailed Description

A class used to generate a normal distribution.

Definition at line 20 of file Maxwellian.h.

Constructor & Destructor Documentation

◆ Maxwellian()

Maxwellian::Maxwellian ( const InputParameters & parameters )

Definition at line 26 of file Maxwellian.C.

   : Distribution(parameters),
     _standard_deviation(
         Maxwellian::standardDeviation(getParam<Real>("mass"), getParam<Real>("temperature")))
 
 {
 }

Member Function Documentation

◆ cdf() [1/2]

Real Maxwellian::cdf	(	const Real &	x,
		const Real &	mass,
		const Real &	temperature
	)

static

Definition at line 47 of file Maxwellian.C.

 {
   return Normal::cdf(x, 0, standardDeviation(mass, temperature));
 }

◆ cdf() [2/2]

Real Maxwellian::cdf ( const Real & x ) const

overridevirtual

Implements Distribution.

Definition at line 65 of file Maxwellian.C.

 {
   return Normal::cdf(x, 0, _standard_deviation);
 }

◆ pdf() [1/2]

Real Maxwellian::pdf	(	const Real &	x,
		const Real &	mass,
		const Real &	temperature
	)

static

Definition at line 41 of file Maxwellian.C.

 {
   return Normal::pdf(x, 0, standardDeviation(mass, temperature));
 }

◆ pdf() [2/2]

Real Maxwellian::pdf ( const Real & x ) const

overridevirtual

Implements Distribution.

Definition at line 59 of file Maxwellian.C.

 {
   return Normal::pdf(x, 0, _standard_deviation);
 }

◆ quantile() [1/2]

Real Maxwellian::quantile	(	const Real &	p,
		const Real &	mass,
		const Real &	temperature
	)

static

Definition at line 53 of file Maxwellian.C.

 {
   return Normal::quantile(p, 0, standardDeviation(mass, temperature));
 }

◆ quantile() [2/2]

Real Maxwellian::quantile ( const Real & p ) const

overridevirtual

Implements Distribution.

Definition at line 71 of file Maxwellian.C.

 {
   return Normal::quantile(p, 0, _standard_deviation);
 }

◆ standardDeviation()

Real Maxwellian::standardDeviation	(	const Real	mass,
		const Real	temperature
	)

staticprotected

Helper for computing the standard deviation for the equivalent normal distribution.

Parameters

mass	the pass of species at the given temperature in kg
temperature	the temperature of the species in K

Returns: the standard deviation of the equivalent normal distribution

Definition at line 35 of file Maxwellian.C.

Referenced by cdf(), pdf(), and quantile().

 {
   return std::sqrt(k_B * temperature / mass);
 }

◆ validParams()

InputParameters Maxwellian::validParams ( )

static

Definition at line 15 of file Maxwellian.C.

 {
   InputParameters params = Distribution::validParams();
   params.addClassDescription("Maxwellian distribution");
   params.addRequiredRangeCheckedParam<Real>(
       "temperature", "temperature > 0", "The temperature of the distribution in K.");
   params.addRequiredRangeCheckedParam<Real>(
       "mass", "mass > 0", "The mass of the species that are the given temperature in kg.");
   return params;
 }

Member Data Documentation

◆ _standard_deviation

const Real Maxwellian::_standard_deviation

protected

the standard deviation for the equivalent normal distribution

Definition at line 44 of file Maxwellian.h.

Referenced by cdf(), pdf(), and quantile().

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

stochastic_tools/include/distributions/Maxwellian.h
stochastic_tools/src/distributions/Maxwellian.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Maxwellian()

Member Function Documentation

◆ cdf() [1/2]

◆ cdf() [2/2]

◆ pdf() [1/2]

◆ pdf() [2/2]

◆ quantile() [1/2]

◆ quantile() [2/2]

◆ standardDeviation()

◆ validParams()

Member Data Documentation

◆ _standard_deviation