lbe_oxygen_limits Module

Module with the definition of the Oxygen concentration lower limits objects for lead-bismuth eutectic (lbe).

class LowerLimitSaturationIron

Lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Iron at its saturation concentration property class.

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Iron at its saturation concentration passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Iron at its saturation concentration in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film in liquid lbe considering Iron at its saturation concentration by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property description: str

Oxygen concentration lower limit description

Type:

str

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property correlation_name: str

Name of the correlation

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitSaturationChromium

Lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Chromium at its saturation concentration property class.

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Chromium at its saturation concentration passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Chromium at its saturation concentration in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film in liquid lbe considering Chromium at its saturation concentration by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property description: str

Oxygen concentration lower limit description

Type:

str

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property correlation_name: str

Name of the correlation

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitSaturationNickel

Lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Nickel at its saturation concentration property class.

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film in liquid lbe considering Nickel at its saturation concentration by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property description: str

Oxygen concentration lower limit description

Type:

str

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property correlation_name: str

Name of the correlation

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

initialization_helper(property_value: float) float | None

Returns the temperature guess value according to the value of the property passed as argument. It is used by the root finder algorithm in case the return type is not None.

Parameters:

property_value (float) – value of the property

Return type:

None

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitSaturationSilicon

Lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Silicon at its saturation concentration property class.

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Silicon at its saturation concentration passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Silicon at its saturation concentration in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film in liquid lbe considering Silicon at its saturation concentration by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property description: str

Oxygen concentration lower limit description

Type:

str

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property correlation_name: str

Name of the correlation

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitSaturationAluminium

Lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Aluminium at its saturation concentration property class.

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Aluminium at its saturation concentration passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film in liquid lbe considering Aluminium at its saturation concentration in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film in liquid lbe considering Aluminium at its saturation concentration by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property description: str

Oxygen concentration lower limit description

Type:

str

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property correlation_name: str

Name of the correlation

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LBELowerLimitChromiumInterface

Lower limit of oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe property abstract class.

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

property description: str

Oxygen concentration lower limit description

Type:

str

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

abstract correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the property by applying the corresponding correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Return type:

exception

property correlation_name: str

Name of the correlation

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

abstract property range: List[float]

Validity range of the property correlation function identified by the minimum and the maximum values of the temperature

Type:

List[float]

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitChromiumGosse2014

Lower limit of oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe property class implementing the correlation by gosse2014.

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film times Chromium concentration raised to \(2/3\) in liquid lbe by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property correlation_name: str

Name of the correlation

Type:

str

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property description: str

Oxygen concentration lower limit description

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitChromiumCourouau2004

Lower limit of oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe property class implementing the correlation by courouau2004.

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film times Chromium concentration raised to \(2/3\) in liquid lbe by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property correlation_name: str

Name of the correlation

Type:

str

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property description: str

Oxygen concentration lower limit description

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitChromiumMartynov1998

Lower limit of oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe property class implementing the correlation by martynov1998.

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film times Chromium concentration raised to \(2/3\) in liquid lbe by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property correlation_name: str

Name of the correlation

Type:

str

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property description: str

Oxygen concentration lower limit description

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film times the Chromium concentration raised to \(2/3\) in liquid lbe in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LBELowerLimitNickelInterface

Lower limit of oxygen concentration to promote a protective oxide film times the Nickel concentration in liquid lbe property abstract class.

property description: str

Oxygen concentration lower limit description

Type:

str

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

abstract correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the property by applying the corresponding correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Return type:

exception

property correlation_name: str

Name of the correlation

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

initialization_helper(property_value: float) float | None

Returns the temperature guess value according to the value of the property passed as argument. It is used by the root finder algorithm in case the return type is not None.

Parameters:

property_value (float) – value of the property

Return type:

None

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

abstract property range: List[float]

Validity range of the property correlation function identified by the minimum and the maximum values of the temperature

Type:

List[float]

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitNickelMartinelli2010

Lower limit of oxygen concentration to promote a protective oxide film times the Nickel concentration in liquid lbe property class implementing the correlation by martinelli2010.

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float | numpy.ndarray

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film times Nickel concentration in liquid lbe by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property correlation_name: str

Name of the correlation

Type:

str

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property description: str

Oxygen concentration lower limit description

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

initialization_helper(property_value: float) float | None

Returns the temperature guess value according to the value of the property passed as argument. It is used by the root finder algorithm in case the return type is not None.

Parameters:

property_value (float) – value of the property

Return type:

None

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitNickelGosse2014

Lower limit of oxygen concentration to promote a protective oxide film times the Nickel concentration in liquid lbe property class implementing the correlation by gosse2014.

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float | numpy.ndarray

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film times Nickel concentration in liquid lbe by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property correlation_name: str

Name of the correlation

Type:

str

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property description: str

Oxygen concentration lower limit description

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

initialization_helper(property_value: float) float | None

Returns the temperature guess value according to the value of the property passed as argument. It is used by the root finder algorithm in case the return type is not None.

Parameters:

property_value (float) – value of the property

Return type:

None

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LBELowerLimitIronInterface

Lower limit of oxygen concentration to promote a protective oxide film times the Iron concentration raised to \(3/4\) in liquid lbe property abstract class.

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film times the Iron concentration raised to \(3/4\) in liquid lbe passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film times the Iron concentration raised to \(3/4\) in liquid lbe in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

property description: str

Oxygen concentration lower limit description

Type:

str

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

abstract correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the property by applying the corresponding correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Return type:

exception

property correlation_name: str

Name of the correlation

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

abstract property range: List[float]

Validity range of the property correlation function identified by the minimum and the maximum values of the temperature

Type:

List[float]

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitIronGosse2014

Lower limit of oxygen concentration to promote a protective oxide film times the Iron concentration raised to \(3/4\) in liquid lbe property class implementing the correlation by gosse2014.

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film times Iron concentration raised to \(3/4\) in liquid lbe by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property correlation_name: str

Name of the correlation

Type:

str

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property description: str

Oxygen concentration lower limit description

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film times the Iron concentration raised to \(3/4\) in liquid lbe passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film times the Iron concentration raised to \(3/4\) in liquid lbe in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

class LowerLimitIronWeeks1969

Lower limit of oxygen concentration to promote a protective oxide film times the Iron concentration raised to \(3/4\) in liquid lbe property class implementing the correlation by weeks1969.

correlation(T: float, p: float = scipy.constants.atm, verbose: bool = False) float

Returns the value of the Oxygen concentration lower limit to promote a protective oxide film times Iron concentration raised to \(3/4\) in liquid lbe by applying the property correlation.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • verbose (bool, optional) – True to tell the decorator to print a warning message in case of range check failing, False otherwise. By default, False

Returns:

Oxygen concentration in \([wt.\%]\)

Return type:

float

property correlation_name: str

Name of the correlation

Type:

str

property range: List[float]

Temperature validity range of the Oxygen concentration lower limit correlation function

Type:

List[float]

property T_at_max: float

Temperature value corresponding to the maximum value of the property correlation function within the validity range

Type:

float

property T_at_min: float

Temperature value corresponding to the minimum value of the property correlation function within the validity range

Type:

float

compute_bounds() None

Computes the bounds of the property within the validity range, i.e., the minimum and the maximum values of the correlation function inside the validity range, together with the corresponding temperature values. If this method is not invoked, the default values are -nan for the minimum value of the property and for its corresponding temperature, and nan for the maximum value of the property and for its corresponding temperature. The bounding values are computed using the scipy.optimize.minimize_scalar() function by adopting the “Bounded” method (for more details, please refer to the scipy documentation).

Return type:

None

property description: str

Oxygen concentration lower limit description

Type:

str

info(T: float, p: float = scipy.constants.atm, print_info: bool = True, n_tab: int = 0) None | str

Prints the information about the property and about the correlation adopted to compute its value.

Parameters:
  • T (float) – Temperature in \([K]\)

  • p (float, optional) – Pressure in \([Pa]\), by default the atmospheric pressure value, i.e., \(101325.0 Pa\)

  • print_info (bool, optional) – True to print to the console, False for getting the string. By default, True

  • n_tab (int, optional) – Number of indentation tabs used to format the output, by default 0

Returns:

Returns None if print_info=True, otherwise returns the content of the information.

Return type:

None | str

initialization_helper(property_value: float) None | float

Returns the temperature guess value according to the value of the lower limit of Oxygen concentration to promote a protective oxide film times the Iron concentration raised to \(3/4\) in liquid lbe passed as argument. It is used by the root finder algorithm.

Parameters:

property_value (float) – lower limit of Oxygen concentration to promote a protective oxide film times the Iron concentration raised to \(3/4\) in liquid lbe in \([wt.\%]\)

Returns:

Temperature guess value in \([K]\)

Return type:

float

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen concentration lower limit long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str