rs3.loadings.fieldStress.Constant module#

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

Bases: _ProxyObject, IPropertyGroupAccessors

getSigma1() → float#
setSigma1(value: float)#
getSigma2() → float#
setSigma2(value: float)#
getSigma3() → float#
setSigma3(value: float)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(Sigma1: float = None, Sigma2: float = None, Sigma3: float = None)#

Set properties using keyword arguments.

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

Bases: ConstantBase

Examples

See Field Stress Script Examples.

getOrientationType() → LinearDirectionType#
setOrientationType(directionType: LinearDirectionType)#
getTrendPlungeOrientation() → tuple[float, float, float, float]#

Retrieves the trend and plunge orientations of the sigma1 and sigma3 stress axes.

Returns:

A tuple containing:

  • sigma1 trend (degrees)

  • sigma1 plunge (degrees)

  • sigma3 trend (degrees)

  • sigma3 plunge (degrees)

Return type:

tuple[float, float, float, float]

setTrendPlungeOrientation(signma1Trend: float = 0, sigma1Plunge: float = 90, signma3Trend: float = 90, sigma3Plunge: float = 0)#

Sets the trend and plunge orientations for the sigma1 and sigma3 stress axes.

Parameters:

  • signma1Trend (float) – Trend angle of sigma1 in degrees. Default is 0.

  • sigma1Plunge (float) – Plunge angle of sigma1 in degrees. Default is 90.

  • signma3Trend (float) – Trend angle of sigma3 in degrees. Default is 90.

  • sigma3Plunge (float) – Plunge angle of sigma3 in degrees. Default is 0.

getVectorOrientation() → tuple[tuple[float, float, float], tuple[float, float, float]]#

Retrieves the vectors representing the orientations of sigma1 and sigma3.

Returns:

A tuple containing two 3D vectors: - sigma1 vector (x, y, z) - sigma3 vector (x, y, z)

Return type:

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

setVectorOrientation(sigma1=tuple[float, float, float], sigma3=tuple[float, float, float])#

Sets the orientation vectors for sigma1 and sigma3.

Parameters:

  • sigma1 (tuple[float, float, float]) – 3D vector representing sigma1 orientation (x, y, z).

  • sigma3 (tuple[float, float, float]) – 3D vector representing sigma3 orientation (x, y, z).

Note

The sigma1 and sigma3 vectors must be orthogonal (i.e., their dot product should be zero)