pdm_objects module

This module contains the classes used to wrap the autogenerated classes from GRPC. Usually, the script writer does not have to look here, but the documentation is included for completeness.

class rips.generated.pdm_objects.Case(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

The ResInsight base class for Cases

file_path

Case File Name

Type:str
id

Case ID

Type:int
name

Case Name

Type:str
class rips.generated.pdm_objects.CellColors(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.EclipseResult

Eclipse Cell Colors class

class rips.generated.pdm_objects.DataContainerFloat(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

values

Float Values

Type:List of float
class rips.generated.pdm_objects.DataContainerString(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

values

String Values

Type:List of str
class rips.generated.pdm_objects.DataContainerTime(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

values

Time Values

Type:List of time
class rips.generated.pdm_objects.DepthTrackPlot(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PlotWindow

auto_scale_depth_enabled

Auto Scale

Type:str
axis_title_font_size

Axis Title Font Size

Type:str
axis_value_font_size

Axis Value Font Size

Type:str
depth_type

Type

Type:str
depth_unit

Unit

Type:str
maximum_depth

Max

Type:float
minimum_depth

Min

Type:float
show_depth_grid_lines

Show Grid Lines

Type:str
show_title_in_plot

Show Title

Type:str
sub_title_font_size

Track Title Font Size

Type:str
class rips.generated.pdm_objects.EclipseCase(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.Reservoir

The Regular Eclipse Results Case

class rips.generated.pdm_objects.EclipseContourMap(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.EclipseView

A contour map for Eclipse cases

class rips.generated.pdm_objects.EclipseResult(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

An eclipse result definition

flow_tracer_selection_mode

Tracers

Type:str
phase_selection

Phases

Type:str
porosity_model_type

Porosity

Type:str
result_type

Type

Type:str
result_variable

Variable

Type:str
selected_injector_tracers

Injector Tracers

Type:List of str
selected_producer_tracers

Producer Tracers

Type:List of str
selected_souring_tracers

Tracers

Type:List of str
class rips.generated.pdm_objects.EclipseView(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.View

The Eclipse 3d Reservoir View

cell_result()

Cell Result :returns: CellColors

cell_result_data()

Current Eclipse Cell Result :returns: str

set_cell_result_data(values)

Set Current Eclipse Cell Result :param values: data :type values: str

class rips.generated.pdm_objects.FileSummaryCase(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.SummaryCase

A Summary Case based on SMSPEC files

include_restart_files

Include Restart Files

Type:str
class rips.generated.pdm_objects.FileWellPath(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.WellPath

Well Paths Loaded From File

class rips.generated.pdm_objects.FractureModelPlot(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.DepthTrackPlot

A fracture model plot

class rips.generated.pdm_objects.GeoMechCase(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.Case

The Abaqus Based GeoMech Case

views()

All GeoMech Views in the Case :returns: List of GeoMechView

class rips.generated.pdm_objects.GeoMechContourMap(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.GeoMechView

A contour map for GeoMech cases

class rips.generated.pdm_objects.GeoMechView(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.View

The Geomechanical 3d View

class rips.generated.pdm_objects.GridCaseGroup(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

A statistics case group

group_id

Case Group ID

Type:int
user_description

Name

Type:str
class rips.generated.pdm_objects.GridSummaryCase(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.SummaryCase

A Summary Case based on extracting grid data.

class rips.generated.pdm_objects.ModeledWellPath(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.WellPath

A Well Path created interactively in ResInsight

class rips.generated.pdm_objects.Plot(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PlotWindow

The Abstract Base Class for all Plot Objects

class rips.generated.pdm_objects.PlotWindow(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.ViewWindow

The Abstract base class for all MDI Windows in the Plot Window

id

View ID

Type:int
class rips.generated.pdm_objects.Project(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

The ResInsight Project

import_summary_case(file_name=None)

Import Summary Case :param file_name: :type file_name: str

Returns:FileSummaryCase
summary_case(case_id=None)

Find Summary Case :param case_id: :type case_id: int

Returns:FileSummaryCase
class rips.generated.pdm_objects.ResampleData(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

time_steps

Time Steps

Type:List of time
values

Values

Type:List of float
class rips.generated.pdm_objects.Reservoir(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.Case

Abtract base class for Eclipse Cases

views()

All Eclipse Views in the case :returns: List of EclipseView

class rips.generated.pdm_objects.SimulationWell(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

An Eclipse Simulation Well

name

Name

Type:str
class rips.generated.pdm_objects.SummaryCase(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

The Base Class for all Summary Cases

auto_shorty_name

Use Auto Display Name

Type:str
id

Case ID

Type:int
short_name

Display Name

Type:str
summary_header_filename

Summary Header File

Type:str
available_addresses()

Arguments:

Returns:DataContainerString
available_time_steps()

Arguments:

Returns:DataContainerTime
resample_values(address=None, resampling_period=None)
Parameters:
  • address (str) -- Formatted address specifying the summary vector
  • resampling_period (str) -- Resampling Period
Returns:

ResampleData

summary_vector_values(address=None)

Create a new Summary Plot :param address: Formatted address specifying the summary vector :type address: str

Returns:DataContainerFloat
class rips.generated.pdm_objects.SummaryCaseSubCollection(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

id

Ensemble ID

Type:int
is_ensemble

Is Ensemble

Type:str
name_count

Name

Type:str
summary_collection_name

Name

Type:str
class rips.generated.pdm_objects.SummaryPlot(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.Plot

A Summary Plot

is_using_auto_name

Auto Title

Type:str
normalize_curve_y_values

Normalize all curves

Type:str
plot_description

Name

Type:str
show_plot_title

Plot Title

Type:str
class rips.generated.pdm_objects.View(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.ViewWindow

background_color

Background

Type:str
current_time_step

Current Time Step

Type:int
disable_lighting

Disable Results Lighting

Type:str
grid_z_scale

Z Scale

Type:float
id

View ID

Type:int
perspective_projection

Perspective Projection

Type:str
show_grid_box

Show Grid Box

Type:str
show_z_scale

Show Z Scale Label

Type:str
class rips.generated.pdm_objects.ViewWindow(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

The Base Class for all Views and Plots in ResInsight

class rips.generated.pdm_objects.WbsParameters(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

df_source

Depletion Factor (DF)

Type:str
fg_multiplier

SH Multiplier for FG in Shale

Type:float
fg_shale_source

FG in Shale Calculation

Type:str
k0_fg_source

K0_FG

Type:str
k0_sh_source

K0_SH

Type:str
obg0_source

Initial Overburden Gradient

Type:str
poission_ratio_source

Poisson Ratio

Type:str
pore_pressure_non_reservoir_source

Non-Reservoir Pore Pressure

Type:str
pore_pressure_reservoir_source

Reservoir Pore Pressure

Type:str
ucs_source

Uniaxial Compressive Strength

Type:str
user_df

User Defined DF

Type:float
user_k0_fg

User Defined K0_FG

Type:float
user_k0_sh

User Defined K0_SH

Type:float
user_poisson_ratio

User Defined Poisson Ratio

Type:float
user_pp_non_reservoir

Multiplier of hydrostatic PP

Type:float
user_ucs

User Defined UCS [bar]

Type:float
water_density

Density of Sea Water [g/cm^3]

Type:float
class rips.generated.pdm_objects.WellBoreStabilityPlot(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.WellLogPlot

A GeoMechanical Well Bore Stabilit Plot

parameters()

Well Bore Stability Parameters :returns: WbsParameters

class rips.generated.pdm_objects.WellLogPlot(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.DepthTrackPlot

A Well Log Plot With a shared Depth Axis and Multiple Tracks

class rips.generated.pdm_objects.WellPath(pb2_object=None, channel=None)

Bases: rips.generated.pdm_objects.PdmObject

The Base class for Well Paths

name

Name

Type:str
generated.pdm_objects = <module 'rips.generated.pdm_objects' from '/home/docs/checkouts/readthedocs.org/user_builds/python-rips-doc/checkouts/stable/docs/rips/generated/pdm_objects.py'>