rs3.loadings.fieldStress.AdvancedGravity module#

class rs3.loadings.fieldStress.AdvancedGravity.AdvancedGravityBase(client: Client, id: str)#

Bases: _ProxyObject, IPropertyGroupAccessors

getGroundSurfaceElevation(materialName: str) → float#
setGroundSurfaceElevation(materialName: str, value: float)#
getOverburdenUnitWeight(materialName: str) → float#
setOverburdenUnitWeight(materialName: str, value: float)#
getSigmaH1K1(materialName: str) → float#
setSigmaH1K1(materialName: str, value: float)#
getSigmaH1K1a(materialName: str) → float#
setSigmaH1K1a(materialName: str, value: float)#
getSigmaH1K1b(materialName: str) → float#
setSigmaH1K1b(materialName: str, value: float)#
getSigmaH1K1c(materialName: str) → float#
setSigmaH1K1c(materialName: str, value: float)#
getSigmaH1LockedIn(materialName: str) → float#
setSigmaH1LockedIn(materialName: str, value: float)#
getSigmaH2K2(materialName: str) → float#
setSigmaH2K2(materialName: str, value: float)#
getSigmaH2K2a(materialName: str) → float#
setSigmaH2K2a(materialName: str, value: float)#
getSigmaH2K2b(materialName: str) → float#
setSigmaH2K2b(materialName: str, value: float)#
getSigmaH2K2c(materialName: str) → float#
setSigmaH2K2c(materialName: str, value: float)#
getSigmaH2LockedIn(materialName: str) → float#
setSigmaH2LockedIn(materialName: str, value: float)#
getProperties(materialName: str)#

Retrieve properties as a dictionary.

setProperties(materialName: str, GroundSurfaceElevation: float = None, OverburdenUnitWeight: float = None, SigmaH1K1: float = None, SigmaH1K1a: float = None, SigmaH1K1b: float = None, SigmaH1K1c: float = None, SigmaH1LockedIn: float = None, SigmaH2K2: float = None, SigmaH2K2a: float = None, SigmaH2K2b: float = None, SigmaH2K2c: float = None, SigmaH2LockedIn: float = None)#

Set properties using keyword arguments.

class rs3.loadings.fieldStress.AdvancedGravity.AdvancedGravity(client: Client, id: str)#

Bases: AdvancedGravityBase

Examples

See Field Stress Script Examples.

getApplyCustomFieldStress(materialName: str) → bool#
setApplyCustomFieldStress(materialName: str, value: bool)#
getTrendPlungeOrientation(materialName: str) → tuple[float, float, float]#

Retrieves the trend and plunge orientations of the vertical and horizontal stress axes.

Returns:

A tuple containing:

  • vertical stress trend angle in degrees

  • vertical stress plunge angle in degrees

  • horizontal stress trend angle in degrees

Return type:

tuple[float, float, float]

setTrendPlungeOrientation(materialName: str, verticalStressTrend: float = 0, verticalStressPlunge: float = 90, horizontalStressTrend: float = 90)#

Sets the trend and plunge orientations of the vertical and horizontal stress axes.

Parameters:

  • verticalStressTrend (float) – Trend angle of the vertical stress in degrees. Default is 0.

  • verticalStressPlunge (float) – Plunge angle of the vertical stress in degrees. Default is 90. The valid data range is (0, 90].

  • horizontalStressTrend (float) – Trend angle of the horizontal stress in degrees. Default is 90.

getVectorOrientation(materialName: str) → tuple[tuple[float, float, float], tuple[float, float, float]]#

Retrieves the vectors representing the directions of the horizontal and vertical stress axes.

Returns:

  • First tuple: horizontal stress 1 vector (x, y, z)

  • Second tuple: vertical stress vector (x, y, z)

Return type:

tuple[tuple[float, float, float], tuple[float, float, float]]

setVectorOrientation(materialName: str, horizontalStress1=tuple[float, float, float], verticalStress=tuple[float, float, float])#

Sets the orientation vectors for the horizontal and vertical stress axes.

Parameters:

  • horizontalStress1 (tuple[float, float, float]) – 3D vector representing horizontal stress 1.

  • verticalStress (tuple[float, float, float]) – 3D vector representing vertical stress.

Note

The horizontal and vertical stress vectors must be orthogonal.