gemseo.uncertainty.distributions.openturns.dirac_settings module#

Settings for the OpenTURNS-based Dirac distributions.

Settings OTDiracDistribution_Settings(*, transformation='', lower_bound=None, upper_bound=None, threshold=0.5, variable_value=0.0)[source]#

Bases: BaseDistribution_Settings, _OTDistribution_Settings_Mixin

The settings of an OpenTURNS-based Dirac distribution.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

  • transformation (str) --

    By default it is set to "".

  • lower_bound (float | None)

  • upper_bound (float | None)

  • threshold (float) --

    By default it is set to 0.5.

  • variable_value (float) --

    By default it is set to 0.0.

Return type:

None

variable_value: float = 0.0#

The value of the random variable.

model_post_init(context, /)#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Parameters:

  • self (BaseModel) -- The BaseModel instance.

  • context (Any) -- The context.

Return type:

None