From 3a97384dcdb5d680edebb41e35c0ddb75edeb0ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rnar=20Grip=20Fj=C3=A6r?= Date: Wed, 2 Aug 2017 14:39:53 +0200 Subject: [PATCH] #1689 Improve help texts of NNC commands for Octave interface --- OctavePlugin/riGetDynamicNNCValues.cpp | 7 ++++++- OctavePlugin/riGetNNCConnections.cpp | 9 +++++++-- OctavePlugin/riGetStaticNNCValues.cpp | 5 ++++- 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/OctavePlugin/riGetDynamicNNCValues.cpp b/OctavePlugin/riGetDynamicNNCValues.cpp index a150dffc39..15e6e2893e 100644 --- a/OctavePlugin/riGetDynamicNNCValues.cpp +++ b/OctavePlugin/riGetDynamicNNCValues.cpp @@ -99,7 +99,12 @@ DEFUN_DLD (riGetDynamicNNCValues, args, nargout, "\n" " riGetDynamicNNCValues([CaseId], PropertyName, [RequestedTimeSteps])\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 (); diff --git a/OctavePlugin/riGetNNCConnections.cpp b/OctavePlugin/riGetNNCConnections.cpp index 05d8a3f524..1610c68cea 100644 --- a/OctavePlugin/riGetNNCConnections.cpp +++ b/OctavePlugin/riGetNNCConnections.cpp @@ -88,8 +88,13 @@ DEFUN_DLD(riGetNNCConnections, args, nargout, "\n" " riGetNNCConnections([CaseId])\n" "\n" - "This function returns a two dimensional matrix containing grid and IJK information\n" - "for each NNC in the requested case." + "This function returns a two dimensional matrix containing grid and IJK information for each NNC in the requested case.\n" + "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(); diff --git a/OctavePlugin/riGetStaticNNCValues.cpp b/OctavePlugin/riGetStaticNNCValues.cpp index 42d92e834e..85f4497a97 100644 --- a/OctavePlugin/riGetStaticNNCValues.cpp +++ b/OctavePlugin/riGetStaticNNCValues.cpp @@ -83,7 +83,10 @@ DEFUN_DLD (riGetStaticNNCValues, args, nargout, "\n" " riGetStaticNNCValues([CaseId], PropertyName)\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 ();