Material#

Soil material library entry. Numeric strength and unit-weight values use project-native units from getProjectUnits(). The cohesion setter parameter is named cohesionKPa for historical wire reasons; pass the value in the project’s native stress unit, not necessarily kilopascals.

class rswall.Material.Material#

Bases: _ProxyObject

Represents a soil material in an RSWall project.

Wraps a SoilData entry in the project property library.

property name: str#: Get the cached material name.

getUnitWeight()#

Unit weight in project native units.

Return type:: float

setUnitWeight(unitWeight)#

Set unit weight in project native units (allows 0; rejects negatives).

Return type:: None
Parameters:: unitWeight (float)

getUseSaturatedWeight()#

Whether saturated unit weight is enabled.

Return type:: bool

setUseSaturatedWeight(useSaturatedWeight)#

Enable or disable saturated unit weight.

Return type:: None
Parameters:: useSaturatedWeight (bool)

getSatUnitWeight()#

Saturated unit weight in project native units.

Return type:: float

setSatUnitWeight(satUnitWeight)#

Set saturated unit weight in project native units (allows 0; rejects negatives).

Return type:: None
Parameters:: satUnitWeight (float)

getFrictionAngle()#

Friction angle in degrees.

Return type:: float

setFrictionAngle(frictionAngleDegrees)#

Set friction angle in degrees.

Return type:: None
Parameters:: frictionAngleDegrees (float)

getInterfaceFrictionAngle()#

Soil-structure friction angle in degrees.

Return type:: float

setInterfaceFrictionAngle(interfaceFrictionAngleDegrees)#

Set soil-structure friction angle in degrees.

Return type:: None
Parameters:: interfaceFrictionAngleDegrees (float)

getCohesion()#

Cohesion in project native stress units.

The underlying wire field is named cohesionKPa; the returned value is still in the project’s native stress unit.

Return type:: float

setCohesion(cohesionKPa)#

Set cohesion in project native stress units.

The parameter is named cohesionKPa for historical wire-protocol reasons. Pass the value in the project’s native stress unit from getProjectUnits() (not necessarily kilopascals).

Return type:: None
Parameters:: cohesionKPa (float)

getInterfaceAdhesionRatio()#

Interface adhesion ratio (0 to 1).

Return type:: float

setInterfaceAdhesionRatio(interfaceAdhesionRatio)#

Set interface adhesion ratio (0 to 1).

Return type:: None
Parameters:: interfaceAdhesionRatio (float)

setName(name)#

Set the name of the material.

Return type:: None
Parameters:: name (str)