Module “driving_force”

class tc_python.property_model_definitions.driving_force.DrivingForce

Bases: object

Encapsulation class for the “Driving Force” property model Arguments and Results.

Arguments

alias of DrivingForce_Arguments

Results

alias of DrivingForce_Results

classmethod get_aliases() → list[str]

List of aliases for “Driving Force” property model.

classmethod get_name() → str

String name of “Driving Force” property model.

class tc_python.property_model_definitions.driving_force.DrivingForce_Arguments

Bases: ArgumentBase

Valid entries for Driving Force property model arguments.

EVALUATION_TEMPERATURE = 'Evaluation temperature'

• Temperature at which the property evaluation occurs, corresponds to the measurement temperature.

• This argument can also be set with PropertyModelCalculation.set_temperature(PropertyModelQuantity.evaluation_temperature())()

Default value:

1000.0 [K]

MATRIX_PHASE = 'matrix'

• Matrix phase selection. Use the special ‘Any phase’ option to rely on phases from the initial equilibrium.

PRECIPITATE_PHASE = DynamicArgument('precipitate')

• Precipitate phase whose driving force is evaluated.

Note

This is a dynamic argument and must be called with an index (e.g., DrivingForce.Arguments.PRECIPITATE_PHASE(0)). Index values start at ‘0’ for the first entry. To specify subsequent index values, you must first call PropertyModelCalculation.invoke_dynamic_argument(argument_id=<this_dynamic_argument>)().

class tc_python.property_model_definitions.driving_force.DrivingForce_Results

Bases: ArgumentBase

Valid entries for Driving Force property model results.

DRIVING_FORCE = 'drivingForce'

• Thermodynamic driving force, J/mol, computed as R*T*DGM(phase).

NORMALIZED_DRIVING_FORCE = 'normalizedDrivingForce'

• Normalized driving force DGM(phase), dimensionless (relative to R*T).