mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
Python Doc : Improve formatting of tables
This commit is contained in:
Magne Sjaastad
@@ -179,23 +179,23 @@ def cell_info_for_active_cells(self, porosity_model="MATRIX_MODEL"):
|
|||||||
Returns:
|
Returns:
|
||||||
List of **CellInfo** objects
|
List of **CellInfo** objects
|
||||||
|
|
||||||
### CellInfo class description
|
**CellInfo class description**::
|
||||||
|
|
||||||
Parameter | Description | Type
|
Parameter | Description | Type
|
||||||
------------------------- | --------------------------------------------- | -----
|
------------------------- | --------------------------------------------- | -----
|
||||||
grid_index | Index to grid | Integer
|
grid_index | Index to grid | Integer
|
||||||
parent_grid_index | Index to parent grid | Integer
|
parent_grid_index | Index to parent grid | Integer
|
||||||
coarsening_box_index | Index to coarsening box | Integer
|
coarsening_box_index | Index to coarsening box | Integer
|
||||||
local_ijk | Cell index in IJK directions of local grid | Vec3i
|
local_ijk | Cell index in IJK directions of local grid | Vec3i
|
||||||
parent_ijk | Cell index in IJK directions of parent grid | Vec3i
|
parent_ijk | Cell index in IJK directions of parent grid | Vec3i
|
||||||
|
|
||||||
### Vec3i class description
|
**Vec3i class description**::
|
||||||
|
|
||||||
Parameter | Description | Type
|
Parameter | Description | Type
|
||||||
---------------- | -------------------------------------------- | -----
|
---------------- | -------------------------------------------- | -----
|
||||||
i | I grid index | Integer
|
i | I grid index | Integer
|
||||||
j | J grid index | Integer
|
j | J grid index | Integer
|
||||||
k | K grid index | Integer
|
k | K grid index | Integer
|
||||||
|
|
||||||
"""
|
"""
|
||||||
active_cell_info_chunks = self.cell_info_for_active_cells_async(
|
active_cell_info_chunks = self.cell_info_for_active_cells_async(
|
||||||
@@ -210,16 +210,18 @@ def cell_info_for_active_cells(self, porosity_model="MATRIX_MODEL"):
|
|||||||
def time_steps(self):
|
def time_steps(self):
|
||||||
"""Get a list containing all time steps
|
"""Get a list containing all time steps
|
||||||
|
|
||||||
The time steps are defined by the class **TimeStepDate** :
|
The time steps are defined by the class **TimeStepDate**
|
||||||
|
|
||||||
Type | Name
|
**TimeStepDate class description**::
|
||||||
--------- | ----------
|
|
||||||
int | year
|
Type | Name
|
||||||
int | month
|
--------- | ----------
|
||||||
int | day
|
int | year
|
||||||
int | hour
|
int | month
|
||||||
int | minute
|
int | day
|
||||||
int | second
|
int | hour
|
||||||
|
int | minute
|
||||||
|
int | second
|
||||||
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
@@ -297,38 +299,40 @@ def export_well_path_completions(
|
|||||||
"""
|
"""
|
||||||
Export well path completions for the current case to file
|
Export well path completions for the current case to file
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
----------------------------| ------------------------------------------------ | -----
|
|
||||||
time_step | Time step to export for | Integer
|
|
||||||
well_path_names | List of well path names | List
|
|
||||||
file_split | Controls how export data is split into files | String enum
|
|
||||||
compdat_export | Compdat export type | String enum
|
|
||||||
include_perforations | Export perforations? | bool
|
|
||||||
include_fishbones | Export fishbones? | bool
|
|
||||||
fishbones_exclude_main_bore | Exclude main bore when exporting fishbones? | bool
|
|
||||||
combination_mode | Settings for multiple completions in same cell | String Enum
|
|
||||||
|
|
||||||
##### Enum file_split
|
Parameter | Description | Type
|
||||||
|
----------------------------| ------------------------------------------------ | -----
|
||||||
|
time_step | Time step to export for | Integer
|
||||||
|
well_path_names | List of well path names | List
|
||||||
|
file_split | Controls how export data is split into files | String enum
|
||||||
|
compdat_export | Compdat export type | String enum
|
||||||
|
include_perforations | Export perforations? | bool
|
||||||
|
include_fishbones | Export fishbones? | bool
|
||||||
|
fishbones_exclude_main_bore | Exclude main bore when exporting fishbones? | bool
|
||||||
|
combination_mode | Settings for multiple completions in same cell | String Enum
|
||||||
|
|
||||||
Option | Description
|
**Enum file_split**::
|
||||||
----------------------------------- | ------------
|
|
||||||
"UNIFIED_FILE" | A single file with all combined transmissibilities
|
|
||||||
"SPLIT_ON_WELL" | One file for each well with combined transmissibilities
|
|
||||||
"SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well
|
|
||||||
|
|
||||||
##### Enum compdat_export
|
Option | Description
|
||||||
|
----------------------------------- | ------------
|
||||||
|
"UNIFIED_FILE" | A single file with all combined transmissibilities
|
||||||
|
"SPLIT_ON_WELL" | One file for each well with combined transmissibilities
|
||||||
|
"SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well
|
||||||
|
|
||||||
Option | Description
|
**Enum compdat_export**::
|
||||||
------------------------------------------- | ------------
|
|
||||||
"TRANSMISSIBILITIES" | Direct export of transmissibilities
|
|
||||||
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include WPIMULT in addition to transmissibilities
|
|
||||||
|
|
||||||
##### Enum combination_mode
|
Option | Description
|
||||||
|
------------------------------------------- | ------------
|
||||||
|
"TRANSMISSIBILITIES" | Direct export of transmissibilities
|
||||||
|
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include WPIMULT in addition to transmissibilities
|
||||||
|
|
||||||
Option | Description
|
**Enum combination_mode**::
|
||||||
------------------- | ------------
|
|
||||||
"INDIVIDUALLY" | Exports the different completion types into separate sections
|
Option | Description
|
||||||
"COMBINED" | Export one combined transmissibility for each cell
|
------------------- | ------------
|
||||||
|
"INDIVIDUALLY" | Exports the different completion types into separate sections
|
||||||
|
"COMBINED" | Export one combined transmissibility for each cell
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(well_path_names, str):
|
if isinstance(well_path_names, str):
|
||||||
@@ -372,16 +376,19 @@ def create_multiple_fractures(
|
|||||||
"""
|
"""
|
||||||
Create Multiple Fractures in one go
|
Create Multiple Fractures in one go
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
-----------------------| ----------------------------------------- | -----
|
|
||||||
template_id | Id of the template | Integer
|
Parameter | Description | Type
|
||||||
well_path_names | List of well path names | List of Strings
|
-----------------------| ----------------------------------------- | -----
|
||||||
min_dist_from_well_td | Minimum distance from well TD | Double
|
template_id | Id of the template | Integer
|
||||||
max_fractures_per_well | Max number of fractures per well | Integer
|
well_path_names | List of well path names | List of Strings
|
||||||
top_layer | Top grid k-level for fractures | Integer
|
min_dist_from_well_td | Minimum distance from well TD | Double
|
||||||
base_layer | Base grid k-level for fractures | Integer
|
max_fractures_per_well | Max number of fractures per well | Integer
|
||||||
spacing | Spacing between fractures | Double
|
top_layer | Top grid k-level for fractures | Integer
|
||||||
action | 'APPEND_FRACTURES' or 'REPLACE_FRACTURES' | String enum
|
base_layer | Base grid k-level for fractures | Integer
|
||||||
|
spacing | Spacing between fractures | Double
|
||||||
|
action | 'APPEND_FRACTURES' or 'REPLACE_FRACTURES' | String enum
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(well_path_names, str):
|
if isinstance(well_path_names, str):
|
||||||
well_path_names = [well_path_names]
|
well_path_names = [well_path_names]
|
||||||
@@ -411,22 +418,24 @@ def create_lgr_for_completion(
|
|||||||
"""
|
"""
|
||||||
Create a local grid refinement for the completions on the given well paths
|
Create a local grid refinement for the completions on the given well paths
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
--------------- | -------------------------------------- | -----
|
|
||||||
time_steps | Time step index | Integer
|
|
||||||
well_path_names | List of well path names | List of Strings
|
|
||||||
refinement_i | Refinment in x-direction | Integer
|
|
||||||
refinement_j | Refinment in y-direction | Integer
|
|
||||||
refinement_k | Refinment in z-direction | Integer
|
|
||||||
split_type | Defines how to split LGRS | String enum
|
|
||||||
|
|
||||||
##### Enum split_type
|
Parameter | Description | Type
|
||||||
|
--------------- | -------------------------------------- | -----
|
||||||
|
time_steps | Time step index | Integer
|
||||||
|
well_path_names | List of well path names | List of Strings
|
||||||
|
refinement_i | Refinment in x-direction | Integer
|
||||||
|
refinement_j | Refinment in y-direction | Integer
|
||||||
|
refinement_k | Refinment in z-direction | Integer
|
||||||
|
split_type | Defines how to split LGRS | String enum
|
||||||
|
|
||||||
Option | Description
|
**Enum split_type**::
|
||||||
------------------------| ------------
|
|
||||||
"LGR_PER_CELL" | One LGR for each completed cell
|
Option | Description
|
||||||
"LGR_PER_COMPLETION" | One LGR for each completion (fracture, perforation, ...)
|
------------------------| ------------
|
||||||
"LGR_PER_WELL" | One LGR for each well
|
"LGR_PER_CELL" | One LGR for each completed cell
|
||||||
|
"LGR_PER_COMPLETION" | One LGR for each completion (fracture, perforation, ...)
|
||||||
|
"LGR_PER_WELL" | One LGR for each well
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(well_path_names, str):
|
if isinstance(well_path_names, str):
|
||||||
@@ -464,14 +473,16 @@ def export_flow_characteristics(
|
|||||||
):
|
):
|
||||||
""" Export Flow Characteristics data to text file in CSV format
|
""" Export Flow Characteristics data to text file in CSV format
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
------------------------- | --------------------------------------------- | -----
|
|
||||||
time_steps | Time step indices | List of Integer
|
Parameter | Description | Type
|
||||||
injectors | Injector names | List of Strings
|
------------------------- | --------------------------------------------- | -----
|
||||||
producers | Producer names | List of Strings
|
time_steps | Time step indices | List of Integer
|
||||||
file_name | Export file name | Integer
|
injectors | Injector names | List of Strings
|
||||||
minimum_communication | Minimum Communication, defaults to 0.0 | Integer
|
producers | Producer names | List of Strings
|
||||||
aquifer_cell_threshold | Aquifer Cell Threshold, defaults to 0.1 | Integer
|
file_name | Export file name | Integer
|
||||||
|
minimum_communication | Minimum Communication, defaults to 0.0 | Integer
|
||||||
|
aquifer_cell_threshold | Aquifer Cell Threshold, defaults to 0.1 | Integer
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(time_steps, int):
|
if isinstance(time_steps, int):
|
||||||
@@ -498,7 +509,7 @@ def available_properties(self,
|
|||||||
"""Get a list of available properties
|
"""Get a list of available properties
|
||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
property_type (str): string corresponding to property_type enum. Choices:
|
property_type (str): string corresponding to property_type enum. Choices::
|
||||||
- DYNAMIC_NATIVE
|
- DYNAMIC_NATIVE
|
||||||
- STATIC_NATIVE
|
- STATIC_NATIVE
|
||||||
- SOURSIMRL
|
- SOURSIMRL
|
||||||
|
|||||||
@@ -225,20 +225,22 @@ class Instance:
|
|||||||
"""
|
"""
|
||||||
Set the export folder used for all export functions
|
Set the export folder used for all export functions
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
---------------- | -------------------------------------------- | -----
|
|
||||||
export_type | String specifying what to export | String
|
|
||||||
path | Path to folder | String
|
|
||||||
create_folder | Create folder if it doesn't exist? | Boolean
|
|
||||||
|
|
||||||
##### Enum export_type
|
Parameter | Description | Type
|
||||||
|
---------------- | -------------------------------------------- | -----
|
||||||
|
export_type | String specifying what to export | String
|
||||||
|
path | Path to folder | String
|
||||||
|
create_folder | Create folder if it doesn't exist? | Boolean
|
||||||
|
|
||||||
Option | Description
|
**Enum export_type**::
|
||||||
--------------- | ------------
|
|
||||||
"COMPLETIONS" |
|
Option | Description
|
||||||
"SNAPSHOTS" |
|
--------------- | ------------
|
||||||
"PROPERTIES" |
|
"COMPLETIONS" |
|
||||||
"STATISTICS" |
|
"SNAPSHOTS" |
|
||||||
|
"PROPERTIES" |
|
||||||
|
"STATISTICS" |
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return self.__execute_command(setExportFolder=Cmd.SetExportFolderRequest(
|
return self.__execute_command(setExportFolder=Cmd.SetExportFolderRequest(
|
||||||
@@ -248,10 +250,13 @@ class Instance:
|
|||||||
"""
|
"""
|
||||||
Set the main window size in pixels
|
Set the main window size in pixels
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
--------- | ---------------- | -----
|
|
||||||
width | Width in pixels | Integer
|
Parameter | Description | Type
|
||||||
height | Height in pixels | Integer
|
--------- | ---------------- | -----
|
||||||
|
width | Width in pixels | Integer
|
||||||
|
height | Height in pixels | Integer
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return self.__execute_command(setMainWindowSize=Cmd.SetWindowSizeParams(
|
return self.__execute_command(setMainWindowSize=Cmd.SetWindowSizeParams(
|
||||||
width=width, height=height))
|
width=width, height=height))
|
||||||
@@ -260,10 +265,12 @@ class Instance:
|
|||||||
"""
|
"""
|
||||||
Set the plot window size in pixels
|
Set the plot window size in pixels
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
--------- | ---------------- | -----
|
|
||||||
width | Width in pixels | Integer
|
Parameter | Description | Type
|
||||||
height | Height in pixels | Integer
|
--------- | ---------------- | -----
|
||||||
|
width | Width in pixels | Integer
|
||||||
|
height | Height in pixels | Integer
|
||||||
"""
|
"""
|
||||||
return self.__execute_command(setPlotWindowSize=Cmd.SetWindowSizeParams(
|
return self.__execute_command(setPlotWindowSize=Cmd.SetWindowSizeParams(
|
||||||
width=width, height=height))
|
width=width, height=height))
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ def apply_cell_result(self, result_type, result_variable):
|
|||||||
"""Apply a regular cell result
|
"""Apply a regular cell result
|
||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
result_type (str): String representing the result category. The valid values are
|
result_type (str): String representing the result category. The valid values are::
|
||||||
- DYNAMIC_NATIVE
|
- DYNAMIC_NATIVE
|
||||||
- STATIC_NATIVE
|
- STATIC_NATIVE
|
||||||
- SOURSIMRL
|
- SOURSIMRL
|
||||||
@@ -39,21 +39,23 @@ def apply_flow_diagnostics_cell_result(
|
|||||||
producers=None):
|
producers=None):
|
||||||
"""Apply a flow diagnostics cell result
|
"""Apply a flow diagnostics cell result
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
------------------- | ------------------------------------------------------ | -----
|
|
||||||
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
|
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
|
||||||
|
|
||||||
Option | Description
|
**Enum compdat_export**::
|
||||||
------------------------| ------------
|
|
||||||
"TOF" | Time of flight
|
Option | Description
|
||||||
"Fraction" | Fraction
|
------------------------| ------------
|
||||||
"MaxFractionTracer" | Max Fraction Tracer
|
"TOF" | Time of flight
|
||||||
"Communication" | Communication
|
"Fraction" | Fraction
|
||||||
|
"MaxFractionTracer" | Max Fraction Tracer
|
||||||
|
"Communication" | Communication
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if injectors is None:
|
if injectors is None:
|
||||||
@@ -89,27 +91,29 @@ def export_sim_well_fracture_completions(self, time_step,
|
|||||||
compdat_export):
|
compdat_export):
|
||||||
"""Export fracture completions for simulation wells
|
"""Export fracture completions for simulation wells
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
----------------------------| ------------------------------------------------ | -----
|
|
||||||
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
|
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
|
||||||
|
|
||||||
Option | Description
|
**Enum file_split**::
|
||||||
----------------------------------- | ------------
|
|
||||||
"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
|
||||||
|
----------------------------------- | ------------
|
||||||
|
"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
|
||||||
|
|
||||||
Option | Description
|
**Enum compdat_export**::
|
||||||
-----------------------------------------| ------------
|
|
||||||
"TRANSMISSIBILITIES"<b>Default Option</b>| Direct export of transmissibilities
|
Option | Description
|
||||||
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include export of WPIMULT
|
-----------------------------------------| ------------
|
||||||
|
"TRANSMISSIBILITIES"<b>Default Option</b>| Direct export of transmissibilities
|
||||||
|
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include export of WPIMULT
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(simulation_well_names, str):
|
if isinstance(simulation_well_names, str):
|
||||||
|
|||||||
@@ -179,23 +179,23 @@ def cell_info_for_active_cells(self, porosity_model="MATRIX_MODEL"):
|
|||||||
Returns:
|
Returns:
|
||||||
List of **CellInfo** objects
|
List of **CellInfo** objects
|
||||||
|
|
||||||
### CellInfo class description
|
**CellInfo class description**::
|
||||||
|
|
||||||
Parameter | Description | Type
|
Parameter | Description | Type
|
||||||
------------------------- | --------------------------------------------- | -----
|
------------------------- | --------------------------------------------- | -----
|
||||||
grid_index | Index to grid | Integer
|
grid_index | Index to grid | Integer
|
||||||
parent_grid_index | Index to parent grid | Integer
|
parent_grid_index | Index to parent grid | Integer
|
||||||
coarsening_box_index | Index to coarsening box | Integer
|
coarsening_box_index | Index to coarsening box | Integer
|
||||||
local_ijk | Cell index in IJK directions of local grid | Vec3i
|
local_ijk | Cell index in IJK directions of local grid | Vec3i
|
||||||
parent_ijk | Cell index in IJK directions of parent grid | Vec3i
|
parent_ijk | Cell index in IJK directions of parent grid | Vec3i
|
||||||
|
|
||||||
### Vec3i class description
|
**Vec3i class description**::
|
||||||
|
|
||||||
Parameter | Description | Type
|
Parameter | Description | Type
|
||||||
---------------- | -------------------------------------------- | -----
|
---------------- | -------------------------------------------- | -----
|
||||||
i | I grid index | Integer
|
i | I grid index | Integer
|
||||||
j | J grid index | Integer
|
j | J grid index | Integer
|
||||||
k | K grid index | Integer
|
k | K grid index | Integer
|
||||||
|
|
||||||
"""
|
"""
|
||||||
active_cell_info_chunks = self.cell_info_for_active_cells_async(
|
active_cell_info_chunks = self.cell_info_for_active_cells_async(
|
||||||
@@ -210,16 +210,18 @@ def cell_info_for_active_cells(self, porosity_model="MATRIX_MODEL"):
|
|||||||
def time_steps(self):
|
def time_steps(self):
|
||||||
"""Get a list containing all time steps
|
"""Get a list containing all time steps
|
||||||
|
|
||||||
The time steps are defined by the class **TimeStepDate** :
|
The time steps are defined by the class **TimeStepDate**
|
||||||
|
|
||||||
Type | Name
|
**TimeStepDate class description**::
|
||||||
--------- | ----------
|
|
||||||
int | year
|
Type | Name
|
||||||
int | month
|
--------- | ----------
|
||||||
int | day
|
int | year
|
||||||
int | hour
|
int | month
|
||||||
int | minute
|
int | day
|
||||||
int | second
|
int | hour
|
||||||
|
int | minute
|
||||||
|
int | second
|
||||||
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
@@ -297,38 +299,40 @@ def export_well_path_completions(
|
|||||||
"""
|
"""
|
||||||
Export well path completions for the current case to file
|
Export well path completions for the current case to file
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
----------------------------| ------------------------------------------------ | -----
|
|
||||||
time_step | Time step to export for | Integer
|
|
||||||
well_path_names | List of well path names | List
|
|
||||||
file_split | Controls how export data is split into files | String enum
|
|
||||||
compdat_export | Compdat export type | String enum
|
|
||||||
include_perforations | Export perforations? | bool
|
|
||||||
include_fishbones | Export fishbones? | bool
|
|
||||||
fishbones_exclude_main_bore | Exclude main bore when exporting fishbones? | bool
|
|
||||||
combination_mode | Settings for multiple completions in same cell | String Enum
|
|
||||||
|
|
||||||
##### Enum file_split
|
Parameter | Description | Type
|
||||||
|
----------------------------| ------------------------------------------------ | -----
|
||||||
|
time_step | Time step to export for | Integer
|
||||||
|
well_path_names | List of well path names | List
|
||||||
|
file_split | Controls how export data is split into files | String enum
|
||||||
|
compdat_export | Compdat export type | String enum
|
||||||
|
include_perforations | Export perforations? | bool
|
||||||
|
include_fishbones | Export fishbones? | bool
|
||||||
|
fishbones_exclude_main_bore | Exclude main bore when exporting fishbones? | bool
|
||||||
|
combination_mode | Settings for multiple completions in same cell | String Enum
|
||||||
|
|
||||||
Option | Description
|
**Enum file_split**::
|
||||||
----------------------------------- | ------------
|
|
||||||
"UNIFIED_FILE" | A single file with all combined transmissibilities
|
|
||||||
"SPLIT_ON_WELL" | One file for each well with combined transmissibilities
|
|
||||||
"SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well
|
|
||||||
|
|
||||||
##### Enum compdat_export
|
Option | Description
|
||||||
|
----------------------------------- | ------------
|
||||||
|
"UNIFIED_FILE" | A single file with all combined transmissibilities
|
||||||
|
"SPLIT_ON_WELL" | One file for each well with combined transmissibilities
|
||||||
|
"SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well
|
||||||
|
|
||||||
Option | Description
|
**Enum compdat_export**::
|
||||||
------------------------------------------- | ------------
|
|
||||||
"TRANSMISSIBILITIES" | Direct export of transmissibilities
|
|
||||||
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include WPIMULT in addition to transmissibilities
|
|
||||||
|
|
||||||
##### Enum combination_mode
|
Option | Description
|
||||||
|
------------------------------------------- | ------------
|
||||||
|
"TRANSMISSIBILITIES" | Direct export of transmissibilities
|
||||||
|
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include WPIMULT in addition to transmissibilities
|
||||||
|
|
||||||
Option | Description
|
**Enum combination_mode**::
|
||||||
------------------- | ------------
|
|
||||||
"INDIVIDUALLY" | Exports the different completion types into separate sections
|
Option | Description
|
||||||
"COMBINED" | Export one combined transmissibility for each cell
|
------------------- | ------------
|
||||||
|
"INDIVIDUALLY" | Exports the different completion types into separate sections
|
||||||
|
"COMBINED" | Export one combined transmissibility for each cell
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(well_path_names, str):
|
if isinstance(well_path_names, str):
|
||||||
@@ -372,16 +376,19 @@ def create_multiple_fractures(
|
|||||||
"""
|
"""
|
||||||
Create Multiple Fractures in one go
|
Create Multiple Fractures in one go
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
-----------------------| ----------------------------------------- | -----
|
|
||||||
template_id | Id of the template | Integer
|
Parameter | Description | Type
|
||||||
well_path_names | List of well path names | List of Strings
|
-----------------------| ----------------------------------------- | -----
|
||||||
min_dist_from_well_td | Minimum distance from well TD | Double
|
template_id | Id of the template | Integer
|
||||||
max_fractures_per_well | Max number of fractures per well | Integer
|
well_path_names | List of well path names | List of Strings
|
||||||
top_layer | Top grid k-level for fractures | Integer
|
min_dist_from_well_td | Minimum distance from well TD | Double
|
||||||
base_layer | Base grid k-level for fractures | Integer
|
max_fractures_per_well | Max number of fractures per well | Integer
|
||||||
spacing | Spacing between fractures | Double
|
top_layer | Top grid k-level for fractures | Integer
|
||||||
action | 'APPEND_FRACTURES' or 'REPLACE_FRACTURES' | String enum
|
base_layer | Base grid k-level for fractures | Integer
|
||||||
|
spacing | Spacing between fractures | Double
|
||||||
|
action | 'APPEND_FRACTURES' or 'REPLACE_FRACTURES' | String enum
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(well_path_names, str):
|
if isinstance(well_path_names, str):
|
||||||
well_path_names = [well_path_names]
|
well_path_names = [well_path_names]
|
||||||
@@ -411,22 +418,24 @@ def create_lgr_for_completion(
|
|||||||
"""
|
"""
|
||||||
Create a local grid refinement for the completions on the given well paths
|
Create a local grid refinement for the completions on the given well paths
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
--------------- | -------------------------------------- | -----
|
|
||||||
time_steps | Time step index | Integer
|
|
||||||
well_path_names | List of well path names | List of Strings
|
|
||||||
refinement_i | Refinment in x-direction | Integer
|
|
||||||
refinement_j | Refinment in y-direction | Integer
|
|
||||||
refinement_k | Refinment in z-direction | Integer
|
|
||||||
split_type | Defines how to split LGRS | String enum
|
|
||||||
|
|
||||||
##### Enum split_type
|
Parameter | Description | Type
|
||||||
|
--------------- | -------------------------------------- | -----
|
||||||
|
time_steps | Time step index | Integer
|
||||||
|
well_path_names | List of well path names | List of Strings
|
||||||
|
refinement_i | Refinment in x-direction | Integer
|
||||||
|
refinement_j | Refinment in y-direction | Integer
|
||||||
|
refinement_k | Refinment in z-direction | Integer
|
||||||
|
split_type | Defines how to split LGRS | String enum
|
||||||
|
|
||||||
Option | Description
|
**Enum split_type**::
|
||||||
------------------------| ------------
|
|
||||||
"LGR_PER_CELL" | One LGR for each completed cell
|
Option | Description
|
||||||
"LGR_PER_COMPLETION" | One LGR for each completion (fracture, perforation, ...)
|
------------------------| ------------
|
||||||
"LGR_PER_WELL" | One LGR for each well
|
"LGR_PER_CELL" | One LGR for each completed cell
|
||||||
|
"LGR_PER_COMPLETION" | One LGR for each completion (fracture, perforation, ...)
|
||||||
|
"LGR_PER_WELL" | One LGR for each well
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(well_path_names, str):
|
if isinstance(well_path_names, str):
|
||||||
@@ -464,14 +473,16 @@ def export_flow_characteristics(
|
|||||||
):
|
):
|
||||||
""" Export Flow Characteristics data to text file in CSV format
|
""" Export Flow Characteristics data to text file in CSV format
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
------------------------- | --------------------------------------------- | -----
|
|
||||||
time_steps | Time step indices | List of Integer
|
Parameter | Description | Type
|
||||||
injectors | Injector names | List of Strings
|
------------------------- | --------------------------------------------- | -----
|
||||||
producers | Producer names | List of Strings
|
time_steps | Time step indices | List of Integer
|
||||||
file_name | Export file name | Integer
|
injectors | Injector names | List of Strings
|
||||||
minimum_communication | Minimum Communication, defaults to 0.0 | Integer
|
producers | Producer names | List of Strings
|
||||||
aquifer_cell_threshold | Aquifer Cell Threshold, defaults to 0.1 | Integer
|
file_name | Export file name | Integer
|
||||||
|
minimum_communication | Minimum Communication, defaults to 0.0 | Integer
|
||||||
|
aquifer_cell_threshold | Aquifer Cell Threshold, defaults to 0.1 | Integer
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(time_steps, int):
|
if isinstance(time_steps, int):
|
||||||
@@ -498,7 +509,7 @@ def available_properties(self,
|
|||||||
"""Get a list of available properties
|
"""Get a list of available properties
|
||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
property_type (str): string corresponding to property_type enum. Choices:
|
property_type (str): string corresponding to property_type enum. Choices::
|
||||||
- DYNAMIC_NATIVE
|
- DYNAMIC_NATIVE
|
||||||
- STATIC_NATIVE
|
- STATIC_NATIVE
|
||||||
- SOURSIMRL
|
- SOURSIMRL
|
||||||
|
|||||||
@@ -225,20 +225,22 @@ class Instance:
|
|||||||
"""
|
"""
|
||||||
Set the export folder used for all export functions
|
Set the export folder used for all export functions
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
---------------- | -------------------------------------------- | -----
|
|
||||||
export_type | String specifying what to export | String
|
|
||||||
path | Path to folder | String
|
|
||||||
create_folder | Create folder if it doesn't exist? | Boolean
|
|
||||||
|
|
||||||
##### Enum export_type
|
Parameter | Description | Type
|
||||||
|
---------------- | -------------------------------------------- | -----
|
||||||
|
export_type | String specifying what to export | String
|
||||||
|
path | Path to folder | String
|
||||||
|
create_folder | Create folder if it doesn't exist? | Boolean
|
||||||
|
|
||||||
Option | Description
|
**Enum export_type**::
|
||||||
--------------- | ------------
|
|
||||||
"COMPLETIONS" |
|
Option | Description
|
||||||
"SNAPSHOTS" |
|
--------------- | ------------
|
||||||
"PROPERTIES" |
|
"COMPLETIONS" |
|
||||||
"STATISTICS" |
|
"SNAPSHOTS" |
|
||||||
|
"PROPERTIES" |
|
||||||
|
"STATISTICS" |
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return self.__execute_command(setExportFolder=Cmd.SetExportFolderRequest(
|
return self.__execute_command(setExportFolder=Cmd.SetExportFolderRequest(
|
||||||
@@ -248,10 +250,13 @@ class Instance:
|
|||||||
"""
|
"""
|
||||||
Set the main window size in pixels
|
Set the main window size in pixels
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
--------- | ---------------- | -----
|
|
||||||
width | Width in pixels | Integer
|
Parameter | Description | Type
|
||||||
height | Height in pixels | Integer
|
--------- | ---------------- | -----
|
||||||
|
width | Width in pixels | Integer
|
||||||
|
height | Height in pixels | Integer
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return self.__execute_command(setMainWindowSize=Cmd.SetWindowSizeParams(
|
return self.__execute_command(setMainWindowSize=Cmd.SetWindowSizeParams(
|
||||||
width=width, height=height))
|
width=width, height=height))
|
||||||
@@ -260,10 +265,12 @@ class Instance:
|
|||||||
"""
|
"""
|
||||||
Set the plot window size in pixels
|
Set the plot window size in pixels
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
--------- | ---------------- | -----
|
|
||||||
width | Width in pixels | Integer
|
Parameter | Description | Type
|
||||||
height | Height in pixels | Integer
|
--------- | ---------------- | -----
|
||||||
|
width | Width in pixels | Integer
|
||||||
|
height | Height in pixels | Integer
|
||||||
"""
|
"""
|
||||||
return self.__execute_command(setPlotWindowSize=Cmd.SetWindowSizeParams(
|
return self.__execute_command(setPlotWindowSize=Cmd.SetWindowSizeParams(
|
||||||
width=width, height=height))
|
width=width, height=height))
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ def apply_cell_result(self, result_type, result_variable):
|
|||||||
"""Apply a regular cell result
|
"""Apply a regular cell result
|
||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
result_type (str): String representing the result category. The valid values are
|
result_type (str): String representing the result category. The valid values are::
|
||||||
- DYNAMIC_NATIVE
|
- DYNAMIC_NATIVE
|
||||||
- STATIC_NATIVE
|
- STATIC_NATIVE
|
||||||
- SOURSIMRL
|
- SOURSIMRL
|
||||||
@@ -39,21 +39,23 @@ def apply_flow_diagnostics_cell_result(
|
|||||||
producers=None):
|
producers=None):
|
||||||
"""Apply a flow diagnostics cell result
|
"""Apply a flow diagnostics cell result
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
------------------- | ------------------------------------------------------ | -----
|
|
||||||
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
|
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
|
||||||
|
|
||||||
Option | Description
|
**Enum compdat_export**::
|
||||||
------------------------| ------------
|
|
||||||
"TOF" | Time of flight
|
Option | Description
|
||||||
"Fraction" | Fraction
|
------------------------| ------------
|
||||||
"MaxFractionTracer" | Max Fraction Tracer
|
"TOF" | Time of flight
|
||||||
"Communication" | Communication
|
"Fraction" | Fraction
|
||||||
|
"MaxFractionTracer" | Max Fraction Tracer
|
||||||
|
"Communication" | Communication
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if injectors is None:
|
if injectors is None:
|
||||||
@@ -89,27 +91,29 @@ def export_sim_well_fracture_completions(self, time_step,
|
|||||||
compdat_export):
|
compdat_export):
|
||||||
"""Export fracture completions for simulation wells
|
"""Export fracture completions for simulation wells
|
||||||
|
|
||||||
Parameter | Description | Type
|
**Parameters**::
|
||||||
----------------------------| ------------------------------------------------ | -----
|
|
||||||
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
|
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
|
||||||
|
|
||||||
Option | Description
|
**Enum file_split**::
|
||||||
----------------------------------- | ------------
|
|
||||||
"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
|
||||||
|
----------------------------------- | ------------
|
||||||
|
"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
|
||||||
|
|
||||||
Option | Description
|
**Enum compdat_export**::
|
||||||
-----------------------------------------| ------------
|
|
||||||
"TRANSMISSIBILITIES"<b>Default Option</b>| Direct export of transmissibilities
|
Option | Description
|
||||||
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include export of WPIMULT
|
-----------------------------------------| ------------
|
||||||
|
"TRANSMISSIBILITIES"<b>Default Option</b>| Direct export of transmissibilities
|
||||||
|
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include export of WPIMULT
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(simulation_well_names, str):
|
if isinstance(simulation_well_names, str):
|
||||||
|
|||||||
Reference in New Issue
Block a user