Module “spinodal”

class tc_python.property_model_definitions.spinodal.Spinodal

Bases: object

Encapsulation class for the “Spinodal” property model Arguments, ArgumentOptions, and Results.

ArgumentOptions

alias of Spinodal_ArgumentOptions

Arguments

alias of Spinodal_Arguments

Results

alias of Spinodal_Results

classmethod get_aliases() → list[str]

List of aliases for “Spinodal” property model.

classmethod get_name() → str

String name of “Spinodal” property model.

class tc_python.property_model_definitions.spinodal.Spinodal_ArgumentOptions

Bases: object

Valid entries for Spinodal property model arguments which require specific options to be entered.

CONDITION_TO_VARY

alias of Spinodal_ArgumentOptions_CONDITION_TO_VARY

class tc_python.property_model_definitions.spinodal.Spinodal_ArgumentOptions_CONDITION_TO_VARY

Bases: ArgumentBase

Valid options for Spinodal.Arguments.CONDITION_TO_VARY.

COMPOSITION = 'X'

Vary Composition during phase transition search.

TEMPERATURE = 'T'

Vary Temperature during phase transition search.

class tc_python.property_model_definitions.spinodal.Spinodal_Arguments

Bases: ArgumentBase

Valid entries for Spinodal property model arguments.

COMPOSITION_CONDITION = 'Composition to vary'

Composition condition to vary/relax during the phase transition search. Valid options: Console mode command for the composition of a component entered in the system (e.g., “X(Fe) or W(Fe)”). This argument is used if the value of Arguments.CONDITION_TO_VARY is set to ArgumentOptions.CONDITION_TO_VARY.COMPOSITION.

CONDITION_TO_VARY = 'varied_condition'

Condition to vary during the spinodal search (e.g., composition or temperature). Valid options: “Temperature”, or a console mode command for the composition of a component entered in the system (e.g., “X(Fe)”) Default Value: “Temperature”

EVALUATION_TEMPERATURE = 'Evaluation temperature'

Temperature at which the property evaluation occurs, corresponds to the measurement temperature. This argument can also be set with :class: PropertyModelCalculation.set_temperature(PropertyModelQuantity.evaluation_temperature()) Default value: 1000.0 [K]

LOWER_CONDITION_LIMIT = 'lower_condition_limit'

Lower limit for spinodal search with manual limits. This argument is used when Arguments.MANUAL_SEARCH_LIMITS is set to “True. Default value: 300.0 [K]

NUM_STEPS = 'Steps in grid when localizing roots'

Number of steps to use when estimating the position(s) of spinodal(s). This argument is used when Arguments.MANUAL_SEARCH_LIMITS is set to “True. Default value: 20

SPINODAL_PHASE = 'matrix'

Phase for which to determine spinodal behavior.

UPPER_CONDITION_LIMIT = 'upper_condition_limit'

Upper limit for spinodal search with manual limits. This argument is used when Arguments.MANUAL_SEARCH_LIMITS is set to “True. Default value: 3000.0 [K]

USE_MANUAL_SEARCH_LIMITS = 'manualSearchLimits'

Option to perform Spinodal search with manual condition limits. If “False”, search limits are set automatically. Argument options: “True”, “False” Default value: “False”

class tc_python.property_model_definitions.spinodal.Spinodal_Results

Bases: ArgumentBase

Valid entries for Spinodal property model results.

SPINODAL_COMPOSITION_1 = 'Spinodal'

Spinodal composition value at the first solution point.

..note::

The result quantity corresponding to this entry is only populated with data if Arguments.CONDITION_TO_VARY is set to ArgumentOptions.CONDITION_TO_VARY.COMPOSITION.

SPINODAL_COMPOSITION_2 = 'Spinodal - 2nd solution'

Spinodal composition value at the second solution point.

..note::

The result quantity corresponding to this entry is only populated with data if Arguments.CONDITION_TO_VARY is set to ArgumentOptions.CONDITION_TO_VARY.COMPOSITION.

SPINODAL_TEMPERATURE_1 = 'Spinodal temperature'

Spinodal temperature for the first solution.

..note::

The result quantity corresponding to this entry is only populated with data if Arguments.CONDITION_TO_VARY is set to ArgumentOptions.CONDITION_TO_VARY.TEMPERATURE.

SPINODAL_TEMPERATURE_2 = 'Spinodal temperature - 2nd solution'

Spinodal temperature for the second solution (if present).

..note::

The result quantity corresponding to this entry is only populated with data if Arguments.CONDITION_TO_VARY is set to ArgumentOptions.CONDITION_TO_VARY.TEMPERATURE.