rs3.loadings.fieldStress.Gravity module#

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

Bases: _ProxyObject, IPropertyGroupAccessors

getUseActualGroundSurface() → bool#
setUseActualGroundSurface(value: bool)#
getGroundSurfaceElevation() → float#
setGroundSurfaceElevation(value: float)#
getOverburdenUnitWeight() → float#
setOverburdenUnitWeight(value: float)#
getUseEffectiveStressRatio() → bool#
setUseEffectiveStressRatio(value: bool)#
getUseNonlinearVariableStressRatio() → bool#
setUseNonlinearVariableStressRatio(value: bool)#
getK0Condition() → bool#
setK0Condition(value: bool)#
getSigmaH1K1() → float#
setSigmaH1K1(value: float)#
getSigmaH1K1a() → float#
setSigmaH1K1a(value: float)#
getSigmaH1K1b() → float#
setSigmaH1K1b(value: float)#
getSigmaH1K1c() → float#
setSigmaH1K1c(value: float)#
getSigmaH1LockedIn() → float#
setSigmaH1LockedIn(value: float)#
getSigmaH2K2() → float#
setSigmaH2K2(value: float)#
getSigmaH2K2a() → float#
setSigmaH2K2a(value: float)#
getSigmaH2K2b() → float#
setSigmaH2K2b(value: float)#
getSigmaH2K2c() → float#
setSigmaH2K2c(value: float)#
getSigmaH2LockedIn() → float#
setSigmaH2LockedIn(value: float)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(UseActualGroundSurface: bool = None, GroundSurfaceElevation: float = None, OverburdenUnitWeight: float = None, UseEffectiveStressRatio: bool = None, UseNonlinearVariableStressRatio: bool = None, K0Condition: bool = 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.Gravity.Gravity(client: Client, id: str)#

Bases: GravityBase

Examples

See Field Stress Script Examples.

getOrientationType() → LinearDirectionType#
setOrientationType(directionType: LinearDirectionType)#
getTrendPlungeOrientation() → 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(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() → 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(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.