BoostNormalDistribution

warning

The BoostNormalDistribution object requires that libMesh be configured to utilize an external Boost library. This may be done by using the --with-boost configuration option when compiling libMesh.

Description

The normal (or Gaussian) distribution object defines a normal distribution function with the provided mean and standard_deviation parameters. The probability density function (PDF) of the normal distribution is given by the Eq. (1).

$(1)var element = document.getElementById("moose-equation-3be49c5a-b54c-4caa-8e2d-d19da797c2a3");katex.render(" f(x \\; | \\; \\mu, \\sigma^2) = \\frac{1}{\\sqrt{2\\pi\\sigma^2} } \\; e^{ -\\frac{(x-\\mu)^2}{2\\sigma^2} }", element, {displayMode:true,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ where $var element = document.getElementById("moose-equation-fe8ebe33-dd6c-410c-b436-ffdb03e63a71");katex.render("\\mu", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the mean and $var element = document.getElementById("moose-equation-747d3577-173b-485d-9323-fff83fe3aada");katex.render("\\sigma", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the standard deviation ( $var element = document.getElementById("moose-equation-592eccef-515e-4e0f-b7a1-002203ab0380");katex.render("\\sigma > 0", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ ) of the distribution.

Example Input Syntax

The following input file defines a normal distribution with a mean of 0 and a standard deviation of 1.

[Distributions]
  [normal_test]
    type = BoostNormalDistribution
    mean = 0
    standard_deviation = 1
  []
[]

/opt/civet/build_0/moose/modules/stochastic_tools/test/tests/distributions/boost_normal.i

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 1
  ny = 1
[]

[Variables]
  [u]
  []
[]

[Distributions]
  [normal_test]
    type = BoostNormalDistribution
    mean = 0
    standard_deviation = 1
  []
[]

[Postprocessors]
  [cdf]
    type = TestDistributionPostprocessor
    distribution = normal_test
    value = 0
    method = cdf
    execute_on = initial
  []
  [pdf]
    type = TestDistributionPostprocessor
    distribution = normal_test
    value = 0
    method = pdf
    execute_on = initial
  []
  [quantile]
    type = TestDistributionPostprocessor
    distribution = normal_test
    value = 0.5
    method = quantile
    execute_on = initial
  []
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
  kernel_coverage_check = false
[]

[Outputs]
  execute_on = 'INITIAL'
  csv = true
  file_base = 'normal_out'
[]

Input Parameters

meanMean of the distribution.
C++ Type:double
Options:
Description:Mean of the distribution.
standard_deviationStandard deviation of the distribution.
C++ Type:double
Options:
Description:Standard deviation of the distribution.

Required Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

modules/stochastic_tools/test/tests/distributions/boost_normal.i

modules/stochastic_tools/test/tests/distributions/boost_normal.i

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 1
  ny = 1
[]

[Variables]
  [u]
  []
[]

[Distributions]
  [normal_test]
    type = BoostNormalDistribution
    mean = 0
    standard_deviation = 1
  []
[]

[Postprocessors]
  [cdf]
    type = TestDistributionPostprocessor
    distribution = normal_test
    value = 0
    method = cdf
    execute_on = initial
  []
  [pdf]
    type = TestDistributionPostprocessor
    distribution = normal_test
    value = 0
    method = pdf
    execute_on = initial
  []
  [quantile]
    type = TestDistributionPostprocessor
    distribution = normal_test
    value = 0.5
    method = quantile
    execute_on = initial
  []
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
  kernel_coverage_check = false
[]

[Outputs]
  execute_on = 'INITIAL'
  csv = true
  file_base = 'normal_out'
[]

Description
Example Input Syntax
Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools