StimPlanModel

class rips.StimPlanModel(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: CheckableNamedObject

anchor_position

Anchor Position

Type:

List[float]

auto_compute_barrier

Auto Compute Barrier

Type:

bool

azimuth_angle

Azimuth Angle

Type:

float

barrier

Barrier

Type:

bool

barrier_dip

Barrier Dip

Type:

float

barrier_fault_name

Barrier Fault

Type:

str

barrier_text_annotation

Barrier Text Annotation

Type:

Optional[RimTextAnnotation]

bounding_box_horizontal

Bounding Box Horizontal

Type:

float

bounding_box_vertical

Bounding Box Vertical

Type:

float

distance_to_barrier

Distance To Barrier [m]

Type:

float

eclipse_case

Dynamic Case

Type:

Optional[Reservoir]

extraction_depth_bottom

Depth

Type:

float

extraction_depth_top

Depth

Type:

float

extraction_offset_bottom

Bottom Offset

Type:

float

extraction_offset_top

Top Offset

Type:

float

extraction_type

One of [TVT, TST]

Type:

str

formation_dip

Formation Dip

Type:

float

fracture_orientation

One of [Longitudinal, Transverse, Azimuth]

Type:

str

initial_pressure_eclipse_case

Initial Pressure Case

Type:

Optional[Reservoir]

measured_depth

Measured Depth

Type:

float

original_thickness_direction

Original Thickness Direction

Type:

List[float]

perforation_interval

Perforation Interval

Type:

Optional[Perforation]

perforation_length

Perforation Length [m]

Type:

float

poro_elastic_constant

Poro-Elastic Constant

Type:

float

relative_permeability_factor

Relative Permeability Factor

Type:

float

show_all_faults

Show All Faults

Type:

bool

show_only_barrier_fault

Show Only Barrier Fault

Type:

bool

static_eclipse_case

Static Case

Type:

Optional[Reservoir]

thermal_expansion_coefficient

Thermal Expansion Coefficient [1/C]

Type:

float

thickness_direction

Thickness Direction

Type:

List[float]

thickness_direction_well_path

Thickness Direction Well Path

Type:

Optional[ModeledWellPath]

time_step

Time Step

Type:

int

use_detailed_fluid_loss

Use Detailed Fluid Loss

Type:

bool

well_penetration_layer

Well Penetration Layer

Type:

int

Methods Summary

export_to_file([directory_path])

Export StimPlan Model Plot to File

Methods Documentation

export_to_file(directory_path: str = '') StimPlanModel | None

Export StimPlan Model Plot to File

Parameters:

directory_path (str) -- Directory Path

Returns:

StimPlanModel