diffusivity_in_bismuth Module

Module with the definition of the diffusivity property objects for bismuth.

class BismuthOxygenDiffusivityInterface

Liquid bismuth 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 description: str

Oxygen diffusivity description

Type:

str

property T_at_max: float

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

Type:

float

property T_at_min: float

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

Type:

float

compute_bounds() → None

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

Return type:

None

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

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

Parameters:

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

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

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

Return type:

exception

property correlation_name: str

Name of the correlation

Type:

str

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

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

Parameters:

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

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

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

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

Returns:

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

Return type:

None | str

initialization_helper(property_value: float) → float | None

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

Parameters:

property_value (float) – value of the property

Return type:

None

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property 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 OxygenDiffusivityFitzner1980

Liquid bismuth Oxygen diffusivity property class implementing the correlation by fitzner1980.

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

Returns the value of the Oxygen diffusivity by applying the property correlation.

Parameters:

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

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

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

Returns:

diffusivity in \([m^2 / s]\)

Return type:

float

property correlation_name: str

Name of the correlation

Type:

str

property range: List[float]

Temperature validity range of the Oxygen diffusivity correlation function

Type:

List[float]

property T_at_max: float

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

Type:

float

property T_at_min: float

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

Type:

float

compute_bounds() → None

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

Return type:

None

property description: str

Oxygen diffusivity description

Type:

str

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

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

Parameters:

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

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

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

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

Returns:

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

Return type:

None | str

initialization_helper(property_value: float) → float | None

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

Parameters:

property_value (float) – value of the property

Return type:

None

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen diffusivity long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen diffusivity unit

Type:

str

class OxygenDiffusivityHeshmatpour1981

Liquid bismuth Oxygen diffusivity property class implementing the correlation by heshmatpour1981.

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

Returns the value of the Oxygen diffusivity by applying the property correlation.

Parameters:

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

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

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

Returns:

diffusivity in \([m^2 / s]\)

Return type:

float

property correlation_name: str

Name of the correlation

Type:

str

property range: List[float]

Temperature validity range of the Oxygen diffusivity correlation function

Type:

List[float]

property T_at_max: float

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

Type:

float

property T_at_min: float

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

Type:

float

compute_bounds() → None

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

Return type:

None

property description: str

Oxygen diffusivity description

Type:

str

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

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

Parameters:

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

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

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

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

Returns:

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

Return type:

None | str

initialization_helper(property_value: float) → float | None

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

Parameters:

property_value (float) – value of the property

Return type:

None

property is_injective: bool

True if the correlation is injective, False otherwise

Type:

bool

property long_name: str

Oxygen diffusivity long name

Type:

str

property max: float

Maximum value of the property correlation function within the validity range

Type:

float

property min: float

Minimum value of the property correlation function within the validity range

Type:

float

property name: str

Name of the property

Type:

str

property units: str

Oxygen diffusivity unit

Type:

str