OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Documentation updates

Browse Source
This commit is contained in:
Magne Sjaastad
2019-08-23 11:42:10 +02:00
parent 45b53af1be
commit d6c80f52a7
3 changed files with 44 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
ApplicationCode/GrpcInterface/Python/rips/Properties.py
View File

@@ -62,18 +62,16 @@ class Properties:
"""Get a list of available properties
Arguments:
propertyType (str): string corresponding to propertyType enum.
Can be one of the following:
'DYNAMIC_NATIVE'
'STATIC_NATIVE'
'SOURSIMRL'
'GENERATED'
'INPUT_PROPERTY'
'FORMATION_NAMES'
'FLOW_DIAGNOSTICS'
'INJECTION_FLOODING'
propertyType (str): string corresponding to propertyType enum. Can be one of the following:
- DYNAMIC_NATIVE
- STATIC_NATIVE
- SOURSIMRL
- GENERATED
- INPUT_PROPERTY
- FORMATION_NAMES
- FLOW_DIAGNOSTICS
- INJECTION_FLOODING
porosityModel(str): 'MATRIX_MODEL' or 'FRACTURE_MODEL'.
"""

35
ApplicationCode/GrpcInterface/Python/rips/View.py
View File

@@ -34,12 +34,18 @@ class View (PdmObject):
def applyCellResult(self, resultType, resultVariable):
"""Apply a regular cell result
Arguments:
resultType [str]: String representing the result category
The valid values are: "DYNAMIC_NATIVE", "STATIC_NATIVE", "SOURSIMRL",
"GENERATED", "INPUT_PROPERTY", "FORMATION_NAMES",
"FLOW_DIAGNOSTICS" and "INJECTION_FLOODING"
resultVariable [str]: String representing the result value.
resultType (str): String representing the result category. The valid values are
- DYNAMIC_NATIVE
- STATIC_NATIVE
- SOURSIMRL
- GENERATED
- INPUT_PROPERTY
- FORMATION_NAMES
- FLOW_DIAGNOSTICS
- INJECTION_FLOODING
resultVariable (str): String representing the result variable.
"""
cellResult = self.cellResult()
cellResult.setValue("ResultType", resultType)
@@ -54,17 +60,18 @@ class View (PdmObject):
"""Apply a flow diagnostics cell result
Arguments:
resultVariable [str]: String representing the result value
resultVariable (str): String representing the result value
The valid values are 'TOF', 'Fraction', 'MaxFractionTracer' and 'Communication'.
selectionMode [str]: String specifying which tracers to select.
The valid values are FLOW_TR_INJ_AND_PROD (all injector and producer tracers)
FLOW_TR_PRODUCERS (all producers)
FLOW_TR_INJECTORS (all injectors)
FLOW_TR_BY_SELECTION (specify individual tracers in the
injectorTracers and producerTracers variables)
injectorTracers [list]: List of injector names (strings) to select.
selectionMode (str): String specifying which tracers to select.
The valid values are
- FLOW_TR_INJ_AND_PROD (all injector and producer tracers),
- FLOW_TR_PRODUCERS (all producers)
- FLOW_TR_INJECTORS (all injectors),
- FLOW_TR_BY_SELECTION (specify individual tracers in the
injectorTracers and producerTracers variables)
injectorTracers (list): List of injector names (strings) to select.
Requires selectionMode to be 'FLOW_TR_BY_SELECTION'.
producerTracers [list]: List of producer tracers (strings) to select.
producerTracers (list): List of producer tracers (strings) to select.
Requires selectionMode to be 'FLOW_TR_BY_SELECTION'.
"""
cellResult = self.cellResult()