Logistic

Logistic distribution.

Description

The logistic distribution is a continuous distribution defined with a location ( $var element = document.getElementById("moose-equation-b3de90f1-acc5-4227-b552-e9ba89e481fe");katex.render("\\alpha", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ ) and shape ( $var element = document.getElementById("moose-equation-ef24d06b-3e84-4d9c-be2b-65f63d3a1788");katex.render("\\beta", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ ) parameters.

Probability Density Function:

var element = document.getElementById("moose-equation-2df8d3f7-3570-473e-bba1-43e058f8f4e6");katex.render("z(x) = \\exp{-\\frac{(x - \\alpha)}{\\beta}} f(x) = \\frac{z(x)}{(\\alpha * (1.0 + z)^2)}", element, {displayMode:true,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});

Cumulative Density Function:

var element = document.getElementById("moose-equation-3eb0f0d3-c0de-4378-a4e6-db567b960e37");katex.render("F(x) = \\frac{1}{1+z(x)}", element, {displayMode:true,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});

Input Parameters

locationLocation or mean of the distribution (alpha or mu)
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Location or mean of the distribution (alpha or mu)
shapeShape of the distribution (beta or s)
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Shape of the distribution (beta or s)

Required Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

(modules/stochastic_tools/test/tests/distributions/logistic.i)

Child Objects

(modules/stochastic_tools/include/distributions/LogisticDistribution.h)

References

No citations exist within this document.

(modules/stochastic_tools/test/tests/distributions/logistic.i)

[StochasticTools]
[]

[Distributions]
  [logistic_test]
    type = Logistic
    location = 1
    shape = 1
  []
[]

[Postprocessors]
  [cdf]
    type = TestDistributionPostprocessor
    distribution = logistic_test
    value = 1.5
    method = cdf
    execute_on = initial
  []
  [pdf]
    type = TestDistributionPostprocessor
    distribution = logistic_test
    value = 1.5
    method = pdf
    execute_on = initial
  []
  [quantile]
    type = TestDistributionPostprocessor
    distribution = logistic_test
    value = 0.5
    method = quantile
    execute_on = initial
  []
[]

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

(modules/stochastic_tools/include/distributions/LogisticDistribution.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "Logistic.h"

/**
 * A deprecated wrapper class used to generate a logistic distribution
 */
class LogisticDistribution : public Logistic
{
public:
  static InputParameters validParams();
  LogisticDistribution(const InputParameters & parameters);
};

Description
Input Parameters
Input Files
Child Objects
References