rs2.modeler.properties.material.StageFactors module

class rs2.modeler.properties.material.StageFactors.StageFactors(client: Client, ID)

Bases: ProxyObject

This interface is specifically for managing the table of stage factors (create, enable/disable, etc…) If you would like to modify specific stage factor values, you must get the stage factors through the stage factor interface present in the property’s module. Ex: stageFactor = strength.HoekBrown.stageFactorInterface.getDefinedStageFactors()[1] stageFactor.setCompressiveStrengthFactor(2)

setStageStrengthStiffnessStageFactors(value: bool)

getStageStrengthStiffnessStageFactors() → bool

setStageThermalStageFactors(value: bool)

getStageThermalStageFactors() → bool

setStageHydraulicStageFactor(value: bool)

getStageHydraulicStageFactor() → bool

setStageHydroDistributionStageFactor(value: bool)

getStageHydroDistributionStageFactor() → bool

setStageDatumStageFactor(value: bool)

getStageDatumStageFactor() → bool

setResetStress(value: bool)

getResetStress() → bool

getDefinedStageFactors() → dict[int, tuple[ProxyObject, ProxyObject, ProxyObject]]

returns a dictionary of the defined stage factors. The key is the stage number and the value is a tuple of stage factors defined for that stage (strengthStiffnessAndDatum, hydraulic, thermal) If a stage factor is not enabled, the values for that type will be None. Datum and Strength/Stiffness factors are combined and must be managed together.

Returns:

dictionary of defined stage factors (strengthStiffnessAndDatum, hydraulic, thermal)

Return type:

dict[int, (ObjectReferenceId, ObjectReferenceId, ObjectReferenceId)

getStageFactor(stage: int) → tuple[ProxyObject, ProxyObject, ProxyObject]

returns the stage factors for the given stage. If a stage factor is not enabled, the values for that type will be None. Datum and Strength/Stiffness factors are combined and must be managed together.

Parameters:

stage (int) – stage number

Returns:

tuple of stage factors (strengthStiffnessAndDatum, hydraulic, thermal)

Return type:

(ObjectReferenceId, ObjectReferenceId, ObjectReferenceId)

setDefinedStageFactors(stageFactors: dict[int, tuple[ProxyObject, ProxyObject, ProxyObject]])

sets the stage factor table for the material. The key is the stage number and the value is a tuple of stage factors defined for that stage (strengthStiffnessAndDatum, hydraulic, thermal) If a type of stage factor is not enabled, the values for that type should be None. If a tuple of stage factors is provided, a value for all enabled types must be provided. Datum and Strength/Stiffness factors are combined and must be managed together.

Parameters:

stageFactors (dict[int, (ObjectReferenceId, ObjectReferenceId, ObjectReferenceId)]) – dictionary of defined stage factors (strengthStiffnessAndDatum, hydraulic, thermal)

createStageFactor(stage: int)

creates a stage factor for the material. A factor must be provided for all enabled types.