Module “propertymodel_factory”

class tc_python.propertymodel_factory.PropertyModelSelection

Bases: object

Factory class providing access to the available Property Model Quantity types.

The returned values from the classmethods are classes (subclasses of tc_python.quantity_factory.PropertyModelQuantity), not instantiated objects. They are intended to be passed to APIs that accept a property model designator (for example a PropertyModelQuantity subclass or its name), and can also be used together with resolve_model_class() and get_model_quantities().

The concrete model implementations are defined in tc_python.property_model_definitions.

classmethod CCT_diagram() → type[tc_python.property_model_definitions.cct_diagram.CCTDiagram]

Returns the CCT model class (CCT diagram).

Returns:

The CCT model class.

classmethod TTT_diagram() → type[tc_python.property_model_definitions.ttt_diagram.TTTDiagram]

Returns the TTTDiagram model class (TTT diagram).

Returns:

The TTTDiagram model class.

classmethod alloy_strength_ti() → type[tc_python.property_model_definitions.alloy_strength_ti.AlloyStrengthTi]

Returns the AlloyStrengthTi model class.

Returns:

The AlloyStrengthTi model class.

classmethod antiphase_boundary_energy_ni() → type[tc_python.property_model_definitions.antiphase_boundary_energy_ni.AntiphaseBoundaryEnergyNi]

Returns the AntiphaseBoundaryEnergyNi model class.

Returns:

The AntiphaseBoundaryEnergyNi model class.

classmethod bainite() → type[tc_python.property_model_definitions.bainite.Bainite]

Returns the Bainite model class.

Returns:

The Bainite model class.

classmethod coarsening() → type[tc_python.property_model_definitions.coarsening.Coarsening]

Returns the Coarsening model class.

Returns:

The Coarsening model class.

classmethod coarsening_ni() → type[tc_python.property_model_definitions.coarsening_ni.CoarseningNi]

Returns the CoarseningNi model class.

Returns:

The CoarseningNi model class.

classmethod columnar_to_equiaxed_transition() → type[tc_python.property_model_definitions.columnar_to_equiaxed_transition.ColumnarToEquiaxedTransition]

Returns the ColumnarToEquiaxedTransition model class.

Returns:

The ColumnarToEquiaxedTransition model class.

classmethod crack_susceptibility_coefficient() → type[tc_python.property_model_definitions.crack_susceptibility_coefficient.CrackSusceptibilityCoefficient]

Returns the CrackSusceptibilityCoefficient model class.

Returns:

The CrackSusceptibilityCoefficient model class.

classmethod critical_transformation_temperatures() → type[tc_python.property_model_definitions.critical_transformation_temperatures.CriticalTransformationTemperatures]

Returns the CriticalTransformationTemperatures model class.

Returns:

The CriticalTransformationTemperatures model class.

classmethod driving_force() → type[tc_python.property_model_definitions.driving_force.DrivingForce]

Returns the DrivingForce model class.

Returns:

The DrivingForce model class.

classmethod equilibrium() → type[tc_python.property_model_definitions.equilibrium.Equilibrium]

Returns the Equilibrium model class.

Returns:

The Equilibrium model class.

classmethod ferrite() → type[tc_python.property_model_definitions.ferrite.Ferrite]

Returns the Ferrite model class.

Returns:

The Ferrite model class.

classmethod freeze_in_equilibrium() → type[tc_python.property_model_definitions.equilibrium_with_freeze_in_temperature.EquilibriumWithFreezeInTemperature]

Returns the EquilibriumWithFreezeInTemperature model class.

Returns:

The EquilibriumWithFreezeInTemperature model class.

classmethod freeze_in_equilibrium_ni() → type[tc_python.property_model_definitions.equilibrium_with_freeze_in_temperature_ni.EquilibriumWithFreezeInTemperatureNi]

Returns the EquilibriumWithFreezeInTemperatureNi model class.

Returns:

The EquilibriumWithFreezeInTemperatureNi model class.

classmethod interfacial_energy() → type[tc_python.property_model_definitions.interfacial_energy.InterfacialEnergy]

Returns the InterfacialEnergy model class.

Returns:

The InterfacialEnergy model class.

classmethod liquidus_solidus() → type[tc_python.property_model_definitions.liquidus_and_solidus_temperature.LiquidusAndSolidusTemperature]

Returns the LiquidusAndSolidusTemperature model class.

Returns:

The LiquidusAndSolidusTemperature model class.

classmethod martensite() → type[tc_python.property_model_definitions.martensite_temperatures.MartensiteTemperatures]

Returns the MartensiteTemperatures model class.

Returns:

The MartensiteTemperatures model class.

classmethod martensite_fraction() → type[tc_python.property_model_definitions.martensite_fractions.MartensiteFractions]

Returns the MartensiteFractions model class.

Returns:

The MartensiteFractions model class.

classmethod martensitic_steel_strength() → type[tc_python.property_model_definitions.martensitic_steel_strength.MartensiticSteelStrength]

Returns the MartensiticSteelStrength model class.

Returns:

The MartensiticSteelStrength model class.

classmethod ms_temperature_ti() → type[tc_python.property_model_definitions.martensite_temperatures_ti.MartensiteTemperaturesTi]

Returns the MartensiteTemperaturesTi model class.

Returns:

The MartensiteTemperaturesTi model class.

classmethod optical_properties_noble() → type[tc_python.property_model_definitions.optical_properties_noble.OpticalPropertiesNoble]

Returns the OpticalPropertiesNoble model class.

Returns:

The OpticalPropertiesNoble model class.

classmethod pearlite() → type[tc_python.property_model_definitions.pearlite.Pearlite]

Returns the Pearlite model class.

Returns:

The Pearlite model class.

classmethod phase_transition() → type[tc_python.property_model_definitions.phase_transition.PhaseTransition]

Returns the PhaseTransition model class.

Returns:

The PhaseTransition model class.

classmethod scheil() → type[tc_python.property_model_definitions.scheil.Scheil]

Returns the Scheil model class.

Returns:

The Scheil model class.

classmethod solvus_for_ordered_phase_ni() → type[tc_python.property_model_definitions.solvus_for_ordered_phase_ni.SolvusForOrderedPhaseNi]

Returns the SolvusForOrderedPhaseNi model class.

Returns:

The SolvusForOrderedPhaseNi model class.

classmethod spinodal() → type[tc_python.property_model_definitions.spinodal.Spinodal]

Returns the Spinodal model class.

Returns:

The Spinodal model class.

classmethod strain_age_cracking_ni() → type[tc_python.property_model_definitions.strain_age_cracking_ni.StrainAgeCrackingNi]

Returns the StrainAgeCrackingNi model class.

Returns:

The StrainAgeCrackingNi model class.

classmethod t_zero() → type[tc_python.property_model_definitions.t_zero_temperature.TZeroTemperature]

Returns the TZero model class (T0 temperature).

Returns:

The TZero model class.

classmethod yield_strength() → type[tc_python.property_model_definitions.yield_strength.YieldStrength]

Returns the YieldStrength model class.

Returns:

The YieldStrength model class.

tc_python.propertymodel_factory.get_model_quantities(model: Union[str, type])

Return (Arguments, Results, ArgumentOptions) classes for a given model designator corresponding to a subclass of PropertyModelQuantities

• If a particular class is not defined by the model, the returned tuple entry None

• e.g., if there is no ArgumentOptions class, return (Arguments, Results, None)

• if the model is unknown, returns (None, None, None)

Parameters:

model – Name of the PropertyModelQuantity class of interest, provided as either a string or a PropertyModelNames Enum

Returns:

Tuple(Union[Arguments, None], Union[Results, None], Union[ArgumentOptions, None])

tc_python.propertymodel_factory.resolve_model_class(model: Union[str, type]) → Optional[type]