diff --git a/OctavePlugin/NNCOctaveInterfaceSpecification.txt b/OctavePlugin/NNCOctaveInterfaceSpecification.txt index 4a2d71eeb4..9c7ebaa882 100644 --- a/OctavePlugin/NNCOctaveInterfaceSpecification.txt +++ b/OctavePlugin/NNCOctaveInterfaceSpecification.txt @@ -1,16 +1,4 @@ -#### 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`. @@ -25,6 +13,15 @@ The columns contain the following information: If the CaseId is not defined, ResInsight's Current Case is used. + +#### Matrix[numSelectedCells][numTimestepsRequested] riGetGridPropertyForSelectedCells([CaseId], PropertyName, [RequestedTimeSteps], [PorosityModel = "Matrix"|"Fracture"] ) + +This function returns a two dimensional matrix: [numSelectedCells][numTimestepsRequested] containing the requested property data from the case with CaseId. + +If the CaseId is not defined, ResInsight's Current Case is used. +The RequestedTimeSteps must contain a list of 1-based indices to the requested time steps. If not defined, all the time steps are returned. + + #### Vector[PropertyInfo] riGetNNCPropertyNames([CaseId]) This function returns the name and type of all NNC properties in the case as a vector of structures. @@ -40,6 +37,19 @@ The structure is defined as: If the CaseId is not defined, ResInsight's Current Case is used. + +#### 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[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 @@ -60,3 +70,4 @@ The "TimeStepIndices" argument is used to "label" all the steps present in the s 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. +