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

User Doc: Typo fixes.

Browse Source
This commit is contained in:
Jacob Støren 2013-10-24 15:04:04 +02:00
parent 312d036129
commit 8024a8cd69
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/UsersGuide/OctaveInterface.md
View File

@ -11,7 +11,7 @@ Octave scripts are available in the **Scripts** folder in the **Project Tree**.
![](images/OctaveScriptTree.png)
This folder contains an entry for each of the directories you have added as a **Script Folder**. Each of the folder lists available `*.m` files and sub directories. The tree is continously updated to reflect the file structure on disk.
This folder contains an entry for each of the directories you have added as a **Script Folder**. Each of the folder lists available `*.m` files and sub directories. The tree is continuously updated to reflect the file structure on disk.
#### Adding Script Folders
You can add directories by right clicking the **Scripts** item to access the context menu.
@ -24,7 +24,7 @@ To enable script editing from ResInsight you need to set up the path to a text e
When done, scripts can be edited using the context menu command **Edit** on the script item in the tree.
### Script execution
Octave scripts can be executed with or without a selection of cases as context. The [ Octave Interface Reference](OctaveInterfaceReference.md) highlights in more depth how to design your octave scripts to utlize these features.
Octave scripts can be executed with or without a selection of cases as context. The [ Octave Interface Reference](OctaveInterfaceReference.md) highlights in more depth how to design your octave scripts to utilize these features.
#### Without a case selection
A script can be started by navigating to the script in the **Project Tree**, and selecting **Execute** from the context menu. The currently active case (The one with the active 3D View) will then be set as ResInsight's *Current Case*.

4
Documentation/UsersGuide/OctaveInterfaceReference.md
View File

@ -40,7 +40,7 @@ The case information is presented in an octave Structure called CaseInfo, and co
}
#### CaseInfo riGetCurrentCase()
This function returns a CaseInfo Structure for the Case considered being the "Current Case" by ResInsight. When ResInsigt loops over a selection of cases and executes an Octave script for each of them, this function returns the CaseInfo for that particular Case.
This function returns a CaseInfo Structure for the Case considered being the "Current Case" by ResInsight. When ResInsight loops over a selection of cases and executes an Octave script for each of them, this function returns the CaseInfo for that particular Case.
#### Vector[CaseInfo] riGetSelectedCases()
This function returns a CaseInfo Structure for each of the cases selected in ResInsight at the time when the script launched.
@ -59,7 +59,7 @@ This function returns a CaseGroupInfo Structure for each of the case groups in t
This function returns a CaseInfo Structure for all the cases in the current ResInsight project, including the Statistics cases and Source cases in a Grid Case Group.
If a CaseGroupId is provided, only the cases in that Case Group will be returned.
### Retreiving Grid Metadata
### Retrieving Grid Metadata
#### Matrix[numActiveCells][9] riGetActiveCellInfo([CaseId], [PorosityModel = "Matrix"|"Fracture"] )
This function returns a two dimensional matrix containing grid and IJK information about each of the active cells in the requested case. The columns contain the following information: