View

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

Bases: ViewWindow

background_color

Background

Type:: str

current_time_step

Current Time Step

Type:: int

disable_lighting

Disable Results Lighting

Type:: bool

grid_z_scale

Z Scale

Type:: float

id

View ID

Type:: int

perspective_projection

Perspective Projection

Type:: bool

show_grid_box

Show Grid Box

Type:: bool

show_z_scale

Show Z Scale Label

Type:: bool

Methods Summary

`apply_cell_result`(result_type, result_variable)	Apply a regular cell result
`apply_flow_diagnostics_cell_result`([...])	Apply a flow diagnostics cell result
`case`()	Get the case the view belongs to
`clone`()	Clone the current view
`export_property`([undefined_value])	Export the current Eclipse property from the view
`export_sim_well_fracture_completions`(...)	Export fracture completions for simulation wells
`export_visible_cells`([export_keyword, ...])	Export special properties for all visible cells.
`set_time_step`(time_step)	Set the time step for current view

Methods Documentation

apply_cell_result(result_type, result_variable)

Apply a regular cell result

Parameters:

result_type (str) --
String representing the result category. The valid values are::
- DYNAMIC_NATIVE
- STATIC_NATIVE
- SOURSIMRL
- GENERATED
- INPUT_PROPERTY
- FORMATION_NAMES
- FLOW_DIAGNOSTICS
- INJECTION_FLOODING
result_variable (str) -- String representing the result variable.

apply_flow_diagnostics_cell_result(result_variable='TOF', selection_mode='FLOW_TR_BY_SELECTION', injectors=None, producers=None)

Apply a flow diagnostics cell result

Parameters:

Parameter           | Description                                            | Type
------------------- | ------------------------------------------------------ | -----
result_variable     | String representing the result value                   | String
selection_mode      | String specifying which tracers to select              | String
injectors           | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List
producers           | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List

Enum compdat_export:

Option                  | Description
------------------------| ------------
"TOF"                   | Time of flight
"Fraction"              | Fraction
"MaxFractionTracer"     | Max Fraction Tracer
"Communication"         | Communication

case(): Get the case the view belongs to

clone(): Clone the current view

export_property(undefined_value=0.0)

Export the current Eclipse property from the view

Parameters:: undefined_value (double) -- Value to use for undefined values. Defaults to 0.0

export_sim_well_fracture_completions(time_step, simulation_well_names, file_split, compdat_export)

Export fracture completions for simulation wells

Parameters:

Parameter                   | Description                                      | Type
----------------------------| ------------------------------------------------ | -----
time_step                   | Time step to export for                          | Integer
simulation_well_names       | List of simulation well names                    | List
file_split                  | Controls how export data is split into files     | String enum
compdat_export              | Compdat export type                              | String enum

Enum file_split:

Option                              | Description
----------------------------------- | ------------
"UNIFIED_FILE" <b>Default Option</b>| A single file with all transmissibilities
"SPLIT_ON_WELL"                     | One file for each well transmissibilities
"SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well

Enum compdat_export:

Option                                   | Description
-----------------------------------------| ------------
"TRANSMISSIBILITIES"<b>Default Option</b>| Direct export of transmissibilities
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include export of WPIMULT

export_visible_cells(export_keyword='FLUXNUM', visible_active_cells_value=1, hidden_active_cells_value=0, inactive_cells_value=0)

Export special properties for all visible cells.

Parameters:

export_keyword (string) -- The keyword to export.
Choices -- 'FLUXNUM' or 'MULTNUM'. Default: 'FLUXNUM'
visible_active_cells_value (int) -- Value to export forvisible active cells. Default: 1
hidden_active_cells_value (int) -- Value to export for hidden active cells. Default: 0
inactive_cells_value (int) -- Value to export for inactive cells. Default: 0

set_time_step(time_step): Set the time step for current view