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

Variables:: stageFactorInterface (AbsoluteStageFactorGettersInterface[InitialConditionsDefinedStageFactor, InitialConditionsStageFactor]) – Reference object for modifying stage factor property.

Examples

Code Snippet: Manipulation of Material Initial Condition Stage Factor Properties

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()#