BoostLognormalDistribution

warning

The BoostLognormalDistribution 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 lognormal distribution object defines a lognormal distribution function with the provided location and scale parameters. The location parameter is equal to the median of the underlying normal distribution (equal to $var element = document.getElementById("moose-equation-0babfd99-d1df-4642-9532-5d7780030e1f");katex.render("{\\ln}\\theta", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-67f02c75-2a02-4833-bb56-7a559838ff93");katex.render("\\theta", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the median of the lognormal distribution) and the scale parameter is equal to the standard deviation of the underlying normal distribution. The probability density function (PDF) of the lognormal distribution is given by the Eq. (1).

$(1)var element = document.getElementById("moose-equation-4e0a8b1b-0fce-449e-9f37-f40a189062af");katex.render(" f(x \\; | \\; m, s) = \\begin{cases} \\frac{1}{xs\\sqrt{2\\pi}}e^{\\frac{-\\left( {\\ln} x-m \\right)^2}{2s^2}} & x>0 ,\\\\ 0 & x\\leq0, \\end{cases}", element, {displayMode:true,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ where $var element = document.getElementById("moose-equation-308abc7d-70ae-4e40-804c-185c69d0cf6c");katex.render("m", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the location parameter and $var element = document.getElementById("moose-equation-f9d5ab00-95b2-441c-bb52-2fef05ada57c");katex.render("s", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the scale parameter ( $var element = document.getElementById("moose-equation-d60e932e-86b6-4c10-9dbb-3d357e3e6ab7");katex.render("s > 0", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ ).

Example Input Syntax

The following input file defines a lognormal distribution with the location parameter -0.371 and the scale parameter 0.52.

[Distributions]
  [lognormal_test]
    type = BoostLognormalDistribution
    location = -0.371
    scale = 0.52
  []
[]

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

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

[Variables]
  [u]
  []
[]

[Distributions]
  [lognormal_test]
    type = BoostLognormalDistribution
    location = -0.371
    scale = 0.52
  []
[]

[Postprocessors]
  [cdf]
    type = TestDistributionPostprocessor
    distribution = lognormal_test
    value = 0.6
    method = cdf
    execute_on = initial
  []
  [pdf]
    type = TestDistributionPostprocessor
    distribution = lognormal_test
    value = 0.6
    method = pdf
    execute_on = initial
  []
  [quantile]
    type = TestDistributionPostprocessor
    distribution = lognormal_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
[]

Input Parameters

locationThe Lognormal location parameter.
C++ Type:double
Options:
Description:The Lognormal location parameter.
scaleThe Lognormal scale parameter.
C++ Type:double
Options:
Description:The Lognormal scale parameter.

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_lognormal.i

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

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

[Variables]
  [u]
  []
[]

[Distributions]
  [lognormal_test]
    type = BoostLognormalDistribution
    location = -0.371
    scale = 0.52
  []
[]

[Postprocessors]
  [cdf]
    type = TestDistributionPostprocessor
    distribution = lognormal_test
    value = 0.6
    method = cdf
    execute_on = initial
  []
  [pdf]
    type = TestDistributionPostprocessor
    distribution = lognormal_test
    value = 0.6
    method = pdf
    execute_on = initial
  []
  [quantile]
    type = TestDistributionPostprocessor
    distribution = lognormal_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
[]

Description
Example Input Syntax
Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools