tph_common_interface Module

Module with the definition of common property interfaces for thermophysical properties

class SaturationVapourPressureInterface

Liquid metal saturation vapour pressure property abstract class.

property units: str

Saturation vapour pressure unit

Type:

str

property long_name: str

Saturation vapour pressure 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

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]

class SurfaceTensionInterface

Liquid metal surface tension property abstract class.

property units: str

Surface tension unit

Type:

str

property long_name: str

Surface tension 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

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]

class DensityInterface

Liquid metal density property abstract class.

property units: str

Density unit

Type:

str

property long_name: str

Density 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

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]

class ThermalExpansionInterface

Liquid metal thermal expansion coefficient property abstract class.

property units: str

Thermal expansion coefficient unit

Type:

str

property long_name: str

Thermal expansion coefficient 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

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]

class SpeedOfSoundInterface

Liquid metal sound velocity property abstract class.

property units: str

Sound velocity unit

Type:

str

property long_name: str

Sound velocity 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

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]

class IsentropicCompressibilityInterface

Liquid metal isentropic compressibility property abstract class.

property units: str

Isentropic compressibility unit

Type:

str

property long_name: str

Isentropic compressibility 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

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]

class SpecificHeatInterface

Liquid metal specific heat capacity property abstract class.

property correlation_name: str

Name of the correlation

Type:

str

property is_injective: bool

True if the correlation is injective, False otherwise.

Type:

bool

property units: str

Specific heat capacity unit

Type:

str

property long_name: str

Specific heat capacity 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

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

class SpecificEnthalpyInterface

Liquid metal specific enthalpy property abstract class.

property units: str

Specific enthalpy unit

Type:

str

property long_name: str

Specific enthalpy 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

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]

class DynamicViscosityInterface

Liquid metal dynamic viscosity property abstract class.

property units: str

Dynamic viscosity unit

Type:

str

property long_name: str

Dynamic viscosity 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

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]

class ElectricalResistivityInterface

Liquid metal electrical resistivity property abstract class.

property units: str

Electrical resistivity unit

Type:

str

property long_name: str

Electrical resistivity 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

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]

class ThermalConductivityInterface

Liquid metal eutectic thermal conductivity property class.

property units: str

Thermal conductivity unit

Type:

str

property long_name: str

Thermal conductivity 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

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]