OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-01-08 23:23:01 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'hdf-prototype' of https://github.com/OPM/ResInsight into hdf-prototype

Browse Source
This commit is contained in:
Magne Sjaastad 2017-08-14 10:51:22 +02:00
commit b09797bb84
1 changed files with 62 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
OctavePlugin/NNCOctaveInterfaceSpecification.txt Normal file
View File

@ -0,0 +1,62 @@
#### Matrix[numNNCConnections][2] riGetNNCConnections([CaseId])
This function returns a two dimensional matrix containing grid and IJK information about each NNC connection.
Each row contains a from and to cell for the connection.
The cells are specified in a structure defined as:
CellInfo = {
GridIndex = int # Index of the grid the cell resides in.
# Main grid has index 0.
I, J, K = int # 1-based index address of the cell in the grid.
}
#### Matrix[numSelectedCells][5] riGetSelectedCells([CaseId])
This function returns a two dimensional matrix containing the cell info for each selected cell in the case with `CaseId`.
The columns contain the following information:
[CaseId, GridIdx, I, J, K]
CaseId # The ID of the case the cell resides in.
GridIdx # The index of the grid the cell resides in.
# Main grid has index 0
I, J, K # 1-based index of the cell in the grid.
If the CaseId is not defined, ResInsight's Current Case is used.
#### Vector[PropertyInfo] riGetNNCPropertyNames([CaseId])
This function returns the name and type of all NNC properties in the case as a vector of structures.
The structure is defined as:
PropertyInfo {
PropName = string # Name of the property as received from
# the analysis tool
PropType = string # The type of the property: "StaticNative",
# "DynamicNative", "Generated"
}
If the CaseId is not defined, ResInsight's Current Case is used.
#### Matrix[numConnections][numTimestepsRequested] riGetDynamicNNCValues([CaseId], PropertyName, [RequestedTimeSteps])
This function returns a two dimensional matrix: [Num Connections][Num Time Steps Requested] containing the value of the requested property from the case with CaseId. The order of connections is the same as the order from `riGetNNCConnectio
If the CaseId is not defined, ResInsight's Current Case is used.
The RequestedTimeSteps must contain a list of indices to the requested time steps. If not defined, all the timesteps are returned.
#### Vector[numConnections] riGetStaticNNCValues([CaseId], PropertyName)
This function returns a vector of values for the requested static property for each NNC connection. The order of connections is the same as the order from `riGetNNCConnections`.
If the CaseId is not defined, ResInsight's Current Case is used.
#### riSetNNCProperty(Matrix[numNNCConnections][numTimeSteps], [CaseId], PropertyName, [TimeStepIndices])
Interprets the supplied matrix as a property set defined for the NNC connections in the case, and puts the data into ResInsight as a "Generated" property with the name "PropertyName".
The "TimeStepIndices" argument is used to "label" all the steps present in the supplied data matrix and must thus be complete.
The time step data will then be put into ResInsight at the time steps requested.
If the CaseId is not defined, ResInsight's Current Case is used.