rs2.modeler.properties.material package

• rs2.modeler.properties.material.datum package
• rs2.modeler.properties.material.hydraulic package
• rs2.modeler.properties.material.stiffness package
• rs2.modeler.properties.material.strength package
• rs2.modeler.properties.material.thermal package

rs2.modeler.properties.material.InitialConditions module

class rs2.modeler.properties.material.InitialConditions.InitialConditionsStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getUnitWeightFactor() → float

getPorosityValueFactor() → float

class rs2.modeler.properties.material.InitialConditions.InitialConditionsDefinedStageFactor(client: Client, ID, propertyID)

Bases: InitialConditionsStageFactor

setUnitWeightFactor(value: float)

setPorosityValueFactor(value: float)

class rs2.modeler.properties.material.InitialConditions.InitialConditions(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Material Initial Condition Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[InitialConditionsDefinedStageFactor, InitialConditionsStageFactor]

getInitialElementLoading() → InitialElementLoadingType

setInitialElementLoading(value: InitialElementLoadingType)

getAccountForMoistureContentInUnitWeight() → bool

setAccountForMoistureContentInUnitWeight(value: bool)

getDryUnitWeight() → float

setDryUnitWeight(value: float)

getMoistUnitWeight() → float

setMoistUnitWeight(value: float)

getSaturatedUnitWeight() → float

setSaturatedUnitWeight(value: float)

getUnitWeight() → float

setUnitWeight(value: float)

getPorosityValue() → float

setPorosityValue(value: float)

getInitialWaterCondition() → StaticWaterModes

setInitialWaterCondition(value: StaticWaterModes)

getInitialPoreWaterPressure() → float

setInitialPoreWaterPressure(value: float)

getInitialRu() → float

setInitialRu(value: float)

getInitialHuType() → HuTypes

setInitialHuType(value: HuTypes)

getInitialHu() → float

setInitialHu(value: float)

getInitialTemperatureCondition() → StaticWaterModes

setInitialTemperatureCondition(value: StaticWaterModes)

getInitialTemperature() → float

setInitialTemperature(value: float)

setInitialPiezoByName(piezoName: str)

piezoName is the id of the piezo line to be used or “None”.

getInitialPiezoName() → str

Returns the id of the selected initial piezoLine or “None”.

setInitialGridByName(gridName: str)

gridName is the name of the grid to be used. “None” and “Default Grid” are available by default.

getInitialGridName() → str

setInitialTemperatureGridByName(gridName: str)

gridName is the name of the grid to be used. “None” and “Default Grid” are available by default.

getInitialTemperatureGridName() → str

setProperties(InitialElementLoading: InitialElementLoadingType = None, AccountForMoistureContentInUnitWeight: bool = None, DryUnitWeight: float = None, MoistUnitWeight: float = None, SaturatedUnitWeight: float = None, UnitWeight: float = None, PorosityValue: float = None, InitialWaterCondition: StaticWaterModes = None, InitialPoreWaterPressure: float = None, InitialRu: float = None, InitialHuType: HuTypes = None, InitialHu: float = None, InitialTemperatureCondition: StaticWaterModes = None, InitialTemperature: float = None)

getProperties()

rs2.modeler.properties.material.MaterialProperty module

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Material Properties

StageFactors

Reference object for modifying property.

Type:

StageFactors

InitialConditions

Reference object for modifying property.

Type:

InitialConditions

Stiffness

Reference object for modifying property.

Type:

Stiffness

Strength

Reference object for modifying property.

Type:

Strength

Hydraulic

Reference object for modifying property.

Type:

Hydraulic

Thermal

Reference object for modifying property.

Type:

Thermal

Datum

Reference object for modifying property.

Type:

Datum

getMaterialName() → str

setMaterialName(value: str)

getMaterialColor() → int

setMaterialColor(value: int)

getHatch() → bool

setHatch(value: bool)

getHatchStyle() → HatchStyle

setHatchStyle(value: HatchStyle)

getHatchColour() → int

setHatchColour(value: int)

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

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.