tch_common_interface Module

Module with the definition of common property interfaces for thermochemical properties

class OxygenDiffusivityInterface

Liquid metal Oxygen diffusivity property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Oxygen diffusivity unit

Type:

str

property long_name: str

Oxygen diffusivity long name

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

abstract property description: str

Property 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 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

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]

class IronDiffusivityInterface

Liquid metal Iron diffusivity property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Iron diffusivity unit

Type:

str

property long_name: str

Iron diffusivity long name

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

abstract property description: str

Property 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 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

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]

class OxygenPartialPressureInterface

Oxygen partial pressure in liquid metal divided by the Oxygen concentration in liquid metal squared property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Oxygen partial pressure in liquid metal divided by the Oxygen concentration in liquid metal squared unit

Type:

str

property long_name: str

Oxygen partial pressure in liquid metal divided by the Oxygen concentration in liquid metal squared long name

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

abstract property description: str

Property 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 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

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]

class MolarEnthalpyInterface

Liquid metal molar enthalpy variation property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Molar enthalpy variation unit

Type:

str

property long_name: str

Molar enthalpy variation long name

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

abstract property description: str

Property 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 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

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]

class MolarEntropyInterface

Liquid metal molar entropy variation property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Molar entropy variation unit

Type:

str

property long_name: str

Molar entropy variation long name

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

abstract property description: str

Property 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 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

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]

class GibbsFreeEnergyInterface

Liquid metal Gibbs free energy variation property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Gibbs free energy unit

Type:

str

property long_name: str

Gibbs free energy long name

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

abstract property description: str

Property 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 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

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]

class IronSolubilityInterface

Liquid metal Iron solubility property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Iron solubility unit

Type:

str

property long_name: str

Iron solubility long name

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

abstract property description: str

Property 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 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

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]

class NickelSolubilityInterface

Liquid metal Nickel solubility property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Nickel solubility unit

Type:

str

property long_name: str

Nickel solubility long name

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

abstract property description: str

Property 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 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

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]

class ChromiumSolubilityInterface

Liquid metal Chromium solubility property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Chromium solubility unit

Type:

str

property long_name: str

Chromium solubility long name

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

abstract property description: str

Property 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 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

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]

class OxygenSolubilityInterface

Liquid metal Oxygen solubility property abstract class.

property name: str

Name of the property

Type:

str

property units: str

Oxygen solubility unit

Type:

str

property long_name: str

Oxygen solubility long name

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

abstract property description: str

Property 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 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

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]

class LowerLimitSaturationIronInterface

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

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

property long_name: str

Oxygen concentration lower limit long name

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

abstract property description: str

Property 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 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

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]

class LowerLimitSaturationChromiumInterface

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

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

property long_name: str

Oxygen concentration lower limit long name

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

abstract property description: str

Property 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 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

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]

class LowerLimitSaturationNickelInterface

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

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

property long_name: str

Oxygen concentration lower limit long name

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

abstract property description: str

Property 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 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

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]

class LowerLimitSaturationSiliconInterface

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

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

property long_name: str

Oxygen concentration lower limit long name

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

abstract property description: str

Property 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 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

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]

class LowerLimitSaturationAluminiumInterface

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

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

property long_name: str

Oxygen concentration lower limit long name

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

abstract property description: str

Property 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 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

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]

class LowerLimitChromiumInterface

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

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

property long_name: str

Oxygen concentration lower limit long name

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

abstract property description: str

Property 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 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

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]

class LowerLimitNickelInterface

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

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

property long_name: str

Oxygen concentration lower limit long name

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

abstract property description: str

Property 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 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

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]

class LowerLimitIronInterface

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

property name: str

Name of the property

Type:

str

property units: str

Oxygen concentration lower limit unit

Type:

str

property long_name: str

Oxygen concentration lower limit long name

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

abstract property description: str

Property 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 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

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]