rs3.properties.material.initialConditions.InitialConditions module#

class rs3.properties.material.initialConditions.InitialConditions.InitialConditionsBase(client: Client, id: str)#

Bases: _ProxyObject, IPropertyGroupAccessors

getUnitWeight() → float#
setUnitWeight(value: float)#
getAccountForMoistureContentInUnitWeight() → bool#
setAccountForMoistureContentInUnitWeight(value: bool)#
getDryUnitWeight() → float#
setDryUnitWeight(value: float)#
getMoistureUnitWeight() → float#
setMoistureUnitWeight(value: float)#
getSaturatedUnitWeight() → float#
setSaturatedUnitWeight(value: float)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(UnitWeight: float = None, AccountForMoistureContentInUnitWeight: bool = None, DryUnitWeight: float = None, MoistureUnitWeight: float = None, SaturatedUnitWeight: float = None)#

Set properties using keyword arguments.

class rs3.properties.material.initialConditions.InitialConditions.InitialConditions(client: Client, id: str)#

Bases: InitialConditionsBase, WaterConditions

Examples

See Material Initial Conditions Script Examples.

getInitialElementLoading() → InitialElementLoadingType#
setInitialElementLoading(initialElementLoading: InitialElementLoadingType)#
getDryUnitWeight() → float#
getApplyInitialWaterConditions() → bool#
setApplyInitialWaterConditions(value: bool)#
getInitialWaterConditionPropertyByName(waterConditionName: str) → PhreaticConditions#
getAllInitialWaterConditionProperties() → list[PhreaticConditions]#
setInitialWaterCondition(waterType: StaticWaterModes, name: str = '')#

Set the initial water condition in the steady state or trainsient state methods of the current material.

This defines the starting water condition used in hydraulic calculations.

  • If waterType is DRY, no name is required.

  • If waterType refers to a water surface, PWP interpolation surface, or PWP point set, the name must match an existing water table.

  • If waterType is USER_DEFINED_VALUE, the name must match an existing user-defined pore water pressure (PWP) or Ru entry.

Parameters:

  • waterType (WaterConditionWaterType) – The type of water condition to set.

  • name (str, optional) – The name of the water table, PWP dataset, or user-defined PWP to use. Required for all types except DRY. Defaults to an empty string.

Raises:

ValueError – If name is required for the given waterType but is not provided.

getInitialWaterCondition() → str#

Retrieve the name of the current initial water condition in the steady state or trainsient state methods of the current material.

Returns:

The name of the initial water condition or “Dry” if the waterType is DRY.

Return type:

str