rs2.interpreter.supportResults package

rs2.interpreter.supportResults.BoltResult module

class rs2.interpreter.supportResults.BoltResult.BoltElementYieldStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

BOLT_ELEMENT_NOT_YIELDED = 0

BOLT_ELEMENT_TYPE_UNKNOWN_YIELDED = 1

BOLT_ELEMENT_TENSION_YIELDED = 2

BOLT_ELEMENT_SHEAR_YIELDED = 4

BOLT_ELEMENT_TENSIONANDSHEAR_YIELDED = 6

BOLT_ELEMENT_UNDEFINED_YIELDED = -1

class rs2.interpreter.supportResults.BoltResult.BoltYieldingResult(start_x, start_y, end_x, end_y, yielding_flag)

Bases: object

Examples

Code Snippet: Get Support Bolt Results

Attributes: start_x (double): Start X-Coordinate for support bolt. start_y (double): Start Y-Coordinate for support bolt. end_x (double): End X-Coordinate for support bolt. end_y (double): End Y-Coordinate for support bolt. yielding_flag (BoltElementYieldStatus): Enum representing bolt yielded status.

class rs2.interpreter.supportResults.BoltResult.BoltForceDisplacementResult(location_x, location_y, distance, axial_force, axial_stress, shear_force, rock_displacement, bolt_displacement)

Bases: object

Examples

Code Snippet: Get Support Bolt Results

Attributes: location_x (double): Start X-Coordinate for support bolt. location_y (double): Start Y-Coordinate for support bolt. distance (double): Distance of support bolt. axial_force (double): Axial Force for support bolt. axial_stress (double): Axial Stress for support bolt. shear_force (double): Shear Force for support bolt. rock_displacement (double): Rock Displacement for support bolt. bolt_displacement (double): Bolt Displacement for support bolt.

class rs2.interpreter.supportResults.BoltResult.BoltResult(entity_id, entity_data, yielding_results: list[BoltYieldingResult], force_displacement_results: list[BoltForceDisplacementResult])

Bases: object

Examples

Code Snippet: Get Support Bolt Results

Attributes: entity_id (str): Unique Identifier for support bolt. start_x (double): Start X-Coordinate for support bolt. start_y (double): Start Y-Coordinate for support bolt. end_x (double): End X-Coordinate for support bolt. end_y (double): End Y-Coordinate for support bolt. yielding_results (list[BoltYieldingResult]): List of bolt yielding result for support bolt. force_displacement_results (list[BoltForceDisplacementResult]): List of bolt force displacement result for support bolt.

rs2.interpreter.supportResults.CompositeResult module

class rs2.interpreter.supportResults.CompositeResult.PileResult(entity_id, joint_result: list[JointResult], liner_result: list[LinerResult])

Bases: object

Examples

Code Snippet: Get Support Pile Results

Attributes: entity_id (str): Unique Identifier for support pile. joint_result (list[JointResult]): List of all joint results for support pile. liner_result (list[LinerResult]): List of all liner results for support pile.

class rs2.interpreter.supportResults.CompositeResult.CompositeResult(entity_id, joint_result: list[JointResult], liner_result: list[LinerResult])

Bases: object

Examples

Code Snippet: Get Support Composite Results

Attributes: entity_id (str): Unique Identifier for support composite. joint_result (list[JointResult]): List of all joint results for support composite. liner_result (list[LinerResult]): List of all liner results for support composite.

class rs2.interpreter.supportResults.CompositeResult.StructuralResult(entity_id, joint_result: list[JointResult], liner_result: list[LinerResult])

Bases: object

Examples

Code Snippet: Get Support Structural Results

Attributes: entity_id (str): Unique Identifier for support structural. joint_result (list[JointResult]): List of all joint results for support structural. liner_result (list[LinerResult]): List of all liner results for support structural.

rs2.interpreter.supportResults.JointResult module

class rs2.interpreter.supportResults.JointResult.JointElementResult(start_x, start_y, end_x, end_y, distance, normal_stress, shear_stress, confining_stress, normal_displacement, shear_displacement, yielded)

Bases: object

Examples

Code Snippet: Get Support Joint Results

Attributes: start_x (double): Start X-Coordinate for support joint. start_y (double): Start Y-Coordinate for support joint. end_x (double): End X-Coordinate for support joint. end_y (double): End Y-Coordinate for support joint. distance (double): Distance of support joint. normal_stress (double): Normal Stress for support joint. shear_stress (double): Shear Stress for support joint. confining_stress (double): Confining Stress for support joint. normal_displacement (double): Normal Displacement for support joint. shear_displacement (double): Shear Displacement for support joint. yielded (bool): Boolean representing yielded status for support joint.

class rs2.interpreter.supportResults.JointResult.JointResult(entity_id, joint_element_results: list[JointElementResult])

Bases: object

Examples

Code Snippet: Get Support Joint Results

Attributes: entity_id (str): Unique Identifier for support joint. joint_element_results (list[JointElementResult]): List of all joint element result for support joint.

rs2.interpreter.supportResults.LinerResult module

class rs2.interpreter.supportResults.LinerResult.LinerElementResult(composite_layer, node_start, node_end, start_x, start_y, end_x, end_y, distance, axial_force1, axial_force_mid, axial_force2, moment1, moment_mid, moment2, shear_force1, shear_force_mid, shear_force2, axi_sym_force1, axi_sym_force_mid, axi_sym_force2, axi_sym_moment1, axi_sym_moment_mid, axi_sym_moment2, displacement_total1, displacement_total_mid, displacement_total2, displacement_x1, displacement_x_mid, displacement_x2, displacement_y1, displacement_y_mid, displacement_y2, temperature1, temperature_mid, temperature2, curvature1, curvature_mid, curvature2, axial_strain1, axial_strain_mid, axial_strain2, hoop_curvature1, hoop_curvature_mid, hoop_curvature2, hoop_axial_strain1, hoop_axial_strain_mid, hoop_axial_strain2, beam_yield)

Bases: object

Examples

Code Snippet: Get Support Liner Results

composite_layer

Integer representing composite layer for support liner.

Type:

int

node_start

Integer representing start node for support liner.

Type:

int

node_end

Integer representing end node for support liner.

Type:

int

start_x

Start X-Coordinate for support liner.

Type:

double

start_y

Start Y-Coordinate for support liner.

Type:

double

end_x

End X-Coordinate for support liner.

Type:

double

end_y

End Y-Coordinate for support liner.

Type:

double

distance

Distance of support liner.

Type:

double

axial_force1

Axial Force at the first position for support liner.

Type:

double

axial_force_mid

Axial Force at the mid position for support liner.

Type:

double

axial_force2

Axial Force at the second position for support liner.

Type:

double

moment1

First Moment for support liner.

Type:

double

moment_mid

Mid Moment for support liner.

Type:

double

moment2

Second Moment for support liner.

Type:

double

shear_force1

Shear Force at the first position for support liner.

Type:

double

shear_force_mid

Shear Force at the mid position for support liner.

Type:

double

shear_force2

Shear Force at the second position for support liner.

Type:

double

axi_sym_force1

Axial Symmetry Force at the first position for support liner.

Type:

double

axi_sym_force_mid

Axial Symmetry Force at the mid position for support liner.

Type:

double

axi_sym_force2

Axial Symmetry Force at the second position for support liner.

Type:

double

axi_sym_moment1

Axial Symmetry Moment at the first position for support liner.

Type:

double

axi_sym_moment_mid

Axial Symmetry Moment at the mid position for support liner.

Type:

double

axi_sym_moment2

Axial Symmetry Moment at the second position for support liner.

Type:

double

displacement_total1

Total Displacement at the first position for support liner.

Type:

double

displacement_total_mid

Total Displacement at the mid position for support liner.

Type:

double

displacement_total2

Total Displacement at the second position for support liner.

Type:

double

displacement_x1

Horizontal Displacement at the first position for support liner.

Type:

double

displacement_x_mid

Horizontal Displacement at the mid position for support liner.

Type:

double

displacement_x2

Horizontal Displacement at the second position for support liner.

Type:

double

displacement_y1

Vertical Displacement at the first position for support liner.

Type:

double

displacement_y_mid

Vertical Displacement at the mid position for support liner.

Type:

double

displacement_y2

Vertical Displacement at the second position for support liner.

Type:

double

temperature1

Temperature at the first position for support liner.

Type:

double

temperature_mid

Temperature at the mid position for support liner.

Type:

double

temperature2

Temperature at the second position for support liner.

Type:

double

curvature1

Curvature at the first position for support liner.

Type:

double

curvature_mid

Curvature at the mid position for support liner.

Type:

double

curvature2

Curvature at the second position for support liner.

Type:

double

axial_strain1

Axial Strain at the first position for support liner.

Type:

double

axial_strain_mid

Axial Strain at the mid position for support liner.

Type:

double

axial_strain2

Axial Strain at the second position for support liner.

Type:

double

hoop_strain1

Hoop Curvature at the first position for support liner.

Type:

double

hoop_strain_mid

Hoop Curvature at the mid position for support liner.

Type:

double

hoop_strain2

Hoop Curvature at the second position for support liner.

Type:

double

hoop_axial_strain1

Hoop Axial Strain at the first position for support liner.

Type:

double

hoop_axial_strain_mid

Hoop Axial Strain at the mid position for support liner.

Type:

double

hoop_axial_strain2

Hoop Axial Strain at the second position for support liner.

Type:

double

beam_yield

Boolean representing yielded status for support liner.

Type:

bool

class rs2.interpreter.supportResults.LinerResult.LinerResult(entity_id, liner_element_results: list[LinerElementResult])

Bases: object

Examples

Code Snippet: Get Support Liner Results

Attributes: entity_id (str): Unique Identifier for support liner. liner_element_results (list[LinerElementResult]): List of liner element result for support liner.