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

#1689 Improve help texts of NNC commands for Octave interface

Browse Source
This commit is contained in:
Bjørnar Grip Fjær 2017-08-02 14:39:53 +02:00
parent 8c7bd87050
commit 3a97384dcd
3 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
OctavePlugin/riGetDynamicNNCValues.cpp
View File

@ -99,7 +99,12 @@ DEFUN_DLD (riGetDynamicNNCValues, args, nargout,
"\n" "\n"
" riGetDynamicNNCValues([CaseId], PropertyName, [RequestedTimeSteps])\n" " riGetDynamicNNCValues([CaseId], PropertyName, [RequestedTimeSteps])\n"
"\n" "\n"
"This function retrieves the dynamic NNC values for each connection for the requested time steps." "This function returns a matrix with the dynamic NNC values for each connection for the requested time steps.\n"
"The matrix has a number of rows equal to the number of NNC connections and a number of columns equal to the requested time steps.\n"
"\n"
"See riGetNNCConnections for information about each individual connection.\n"
"If the CaseId is not defined, ResInsight's Current Case is used.\n"
"If RequestedTimeSteps are left empty, values for all time steps will be returned.\n"
) )
{ {
int nargin = args.length (); int nargin = args.length ();

9
OctavePlugin/riGetNNCConnections.cpp
View File

@ -88,8 +88,13 @@ DEFUN_DLD(riGetNNCConnections, args, nargout,
"\n" "\n"
" riGetNNCConnections([CaseId])\n" " riGetNNCConnections([CaseId])\n"
"\n" "\n"
"This function returns a two dimensional matrix containing grid and IJK information\n" "This function returns a two dimensional matrix containing grid and IJK information for each NNC in the requested case.\n"
"for each NNC in the requested case." "The columns contain the following information:\n"
"[GridIdx, I, J, K]:\n"
" GridIdx : The index of the grid the cell resides in. (Main grid has index 0)\n"
" I, J, K : 1-based index address of the cell in the grid.\n"
"\n"
"If the CaseId is not defined, ResInsight's Current Case is used.\n"
) )
{ {
int nargin = args.length(); int nargin = args.length();

5
OctavePlugin/riGetStaticNNCValues.cpp
View File

@ -83,7 +83,10 @@ DEFUN_DLD (riGetStaticNNCValues, args, nargout,
"\n" "\n"
" riGetStaticNNCValues([CaseId], PropertyName)\n" " riGetStaticNNCValues([CaseId], PropertyName)\n"
"\n" "\n"
"This function retrieves the static NNC values for each connection." "This function returns a vector with the static NNC values for each connection.\n"
"\n"
"See riGetNNCConnections for information about each individual connection.\n"
"If the CaseId is not defined, ResInsight's Current Case is used.\n"
) )
{ {
int nargin = args.length (); int nargin = args.length ();