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

Started to refine the draft octave interface specification

Browse Source 
p4#: 20243
This commit is contained in:
Jacob Støren
2013-01-25 09:49:54 +01:00
parent 03a3ceb9c1
commit 1d7984c305
1 changed files with 64 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
OctavePlugin/ResInsightOctaveInterfaceSpecification.txt
View File

@@ -1,9 +1,10 @@
riGetMainGridDimensions( [CaseName/CaseIndex])
Vector(3)[ICount, JCount, KCount] riGetMainGridDimensions( [CaseName/CaseIndex])
Returns a vector of size 3: [ICount, JCount, KCount]
Containing the dimensions of the main grid in the requested case.
If the Eclipse Case is not defined, the active View in ResInsight is used."
riSetActiveCellProperty( Matrix(nActiveCells, nTimesteps), [CaseName/CaseIndex], PropertyName )
Interprets the supplied matrix as an eclipse property set, and puts the data into
@@ -11,21 +12,79 @@ ResInsight as a "Generated" property with the name "PropertyName". The property
is added to the active case if no case specification is given, or to the Eclipse Case
named "CaseName" or to the case number "CaseIndex". "
riGetActiveCellProperty( [CaseName/CaseIndex], PropertyName )
Matrix[ActiveCells][Timesteps] riGetActiveCellProperty( [CaseName/CaseIndex], PropertyName )
Returns a two dimentional matrix: [ActiveCells][Timesteps]
Containing the requested property data from the Eclipse Case defined.
If the Eclipse Case is not defined, the active View in ResInsight is used.
riGetActiveCellInfo( [CaseName/CaseIndex])
Matrix[ActiveCells][8] riGetActiveCellInfo( [CaseName/CaseIndex])
Returns a two dimentional matrix: [ActiveCells][8]
Containing grid and ijk information about the cells from the Eclipse Case defined.
The columns contain the following information:
1: GridIndex: The index of the grid the cell resides in. (Main grid has index 0)
2, 3, 4: I, J, K address of the cell in the grid.
2, 3, 4: I, J, K: 1-based index address of the cell in the grid.
5: ParentGridIndex. The index to the grid that this cell's grid is residing in.
6, 7, 8: PI, PJ, PK address of the parent grid cell that this cell is a part of.
If the Eclipse Case is not defined, the active View in ResInsight is used.
If the Eclipse Case is not defined, the active View in ResInsight is used.
Matrix[g0I, g0J, g0K; ... ; gnI, gnJ, gnK] riGetGridDimensions ( [CaseName/CaseIndex])
Returns a matrix: [NuberOfGrids][3]
containing the I, J, K dimentions of the main grid and all the LGR's
NumberOfGrids riGetNumLGRs([Casename/CaseIndex])
Returns an integer telling the number of LGRS in this case
Matrix[numI][numJ][numK][timeSteps] riGetGridProperty( [Casename/CaseIndex], GridIndex , PropertyName )
Matrix[numI][numJ][numK] riGetGridProperty( [Casename/CaseIndex], GridIndex , PropertyName, TimeStep )
Returns a 4D or 3D matrix of the requested property data for all the gridcells in the requested grid.
Grids are indexed from 0 - main grid to Max num LGR's
Vector[Casenames] riGetCaseNames()
Returns a vector of all the case names in the current ResInsight project
Use this to determine the number of cases as well
Vector[Dates] riGetTimestepDates([Casename/CaseIndex])
Returns a vector of all the timesteps in a case as dates YYYY.MM.DD
Vector[Days] riGetTimestepDays([Casename/CaseIndex])
Returns a vector of all the timesteps in a case as days from start
Set Octave function Case ID as a function parameter (enable for loops)
Write grid data to file on .grdecl format (and read & append?)
Grid functions:
riGetCellCenter(case), <20> give UTM coordinates (X, Y, Z) for centerpoint of all cells
riGetCellCorner(case) <20> give UTM koordinatene (X,Y, Z) for all 8 cell corner points for all cells
riGetCellValue(parameter, I, J, K, case) (if needed , ref choice of array type)
Operator to restrict operation to be carried out inside a given polygon object
riInside(polygon)
Well data:
Well names
riGetWellNames(case)
Well trajectories (alternative trajectory like Planned / Drilled /Real Time/ Project ahead?)
riGetTrajectories(well, case) ? MD, Inc, Az, Norht(X), East(Y), TVD(Z),DLS,BUR,TR,prop/log/connections?
<EFBFBD>Execute for all cases within group<75> in script-tree