Updated documentation for release 1.6.0

This commit is contained in:
Jacob Støren
2016-01-11 11:30:44 +01:00
parent 30e3972143
commit 6929e307c9
22 changed files with 203 additions and 13 deletions

View File

@@ -19,7 +19,10 @@ windows can be managed from the **Windows** menu or directly using the local men
- **Project Tree** - contains all application objects in a tree structure.
- **Property Editor** - displays all properties for the selected object in the **Project Tree**
- **Process Monitor** - displays output from Octave when executing Octave scripts
- **Result Info** - displays info for the object being hit in the 3D scene when clicking with left mouse button
- **Result Info** - displays info for the selected object in the 3D scene
- **Result Plot** - displays curves based on result values for the selected cells in the 3D scene
Result Info and Result Plot is described in detail in [ Result Inspection ]({{ site.baseurl }}/docs/resultinspection)
<div class="note">
<h5>Add additional docking windows</h5>

View File

@@ -1,6 +1,6 @@
---
layout: docs
title: ResInsight 1.5
title: ResInsight 1.6
permalink: /docs/home/
published: true
---

65
docs/Intersections.md Normal file
View File

@@ -0,0 +1,65 @@
---
layout: docs
title: Intersections
permalink: /docs/intersections/
published: true
---
![]({{ site.baseurl }}/images/IntersectionOverview.png)
Intersections are cross sections of the grid model vertically or horizontally along a curve. The curve can be either a Simulation Well, a Well Path or a user defined polyline.
Intersections are organized in a folder named **Intersections** in a **View** as shown below.
![]({{ site.baseurl }}/images/IntersectionInTree.png)
A new general intersection can be created by activating ![]({{ site.baseurl }}/images/CrossSection16x16.png) **New Intersection** from the context menu of the **Intersections** item in the Project Tree.
<div class="note info">
To be able to see the intersections in the 3D view, the grid cells can be hidden by disabling the <b>Grids</b> item in the Project Tree or activating the <b>Hide Grid Cells</b> toolbar button.
</div>
The property panel of an Intersection is shown below:
![]({{ site.baseurl }}/images/IntersectionWellPath.png)
#### Intersection Options
Property | Description
---------------|------------
Name | Automatically created based on the item specifying the intersection. The user can customize the name by editing, but will be updated if you change the well or well path.
Intersecting Geometry | These options controls the curve to be used for the cross section, and depends on the type of intersection you choose.
Direction | Horizontal or vertical intersection
Extent length | Defines how far an intersection for Well Path or Simulation Well is extended at intersection ends
Inactive cells | Controls if inactive cells are visualized on the intersection geometry
### Well Path Intersection
A new **Well Path** intersection can be created by right-clicking the well path in the 3D view or in the **Project Tree**.
When a well path intersection is created, the source well path can be changed by using the **Well Path** selection combo box in the **Property Editor**.
### Simulation Well Intersection
A new **Simulation Well** intersection can be created by right-clicking the simulation well in the 3D view or in the **Project Tree**.
![]({{ site.baseurl }}/images/IntersectionSimulationWellProperties.png)
When a simulation well intersection is created, the source simulation well can be changed by using the **Simulation Well** selection combo box in the **Property Editor**.
If the well contains more than one branch, the intersection geometry will be created for the selected brach in the **Branch** combo box.
### Polyline Intersection
A new **Polyline** intersection can be created from the context menu in the 3D view. Then, by left-clicking on reservoir geometry, a polyline is created. The points are added to the point list in the **Property Editor**.
![]({{ site.baseurl }}/images/IntersectionPolyline.png)
The background color of this list is set to light pink when adding points by picking in the 3D view is active. To finish adding points, click the button **Stop picking points** in the **Property Editor**. The background color
of the point list is then set to white.
The points in the list can be deleted and edited using the keyboard.
To append more points by clicking in the 3D view, push the button **Start picking points** again.
The points in the list can be copied to clipboard using **CTRL-C** when keyboard focus is inside the point list. A new list of points can be pasted into the point list by using **CTRL-V**.

View File

@@ -15,6 +15,14 @@ Views of Eclipse models and Geomechanical models has a lot in common, but Eclips
## Common view features
### View properties
![]({{ site.baseurl }}/images/ViewProperties.png)
Grid appearance can be controlled from the **Property Editor** when a view is selected. This includes background color and z scaling. In addition, cell visibilty controls of inactive and invalid cells.
Visibility of the grid box with labels displaying the coordinates for the reservoir can also be controlled using **Show Grid Box**.
### Cell Result &nbsp;![]({{ site.baseurl }}/images/CellResult.png)
The **Cell Result** item defines which Eclipse property the 3D View uses for the main cell color. The property can be chosen in the property panel of the **Cell Result** item. The mapping between cell values and color is defined by the **Legend Definition** ![]({{ site.baseurl }}/images/Legend.png) along with some appearance settings on the Legend itself. (Number format etc.)
@@ -43,6 +51,24 @@ The **Histogram** shows a histogram of the complete time series of the currently
![]({{ site.baseurl }}/images/HistogramExample.png)
**Statistics Time Range** controls if a single time step or all time steps are included when statistics is computed.
**Statistics Cell Range** controls if visible cells or all active cells is included when statistics is computed.
<div class="note">
The <b>Text Box</b> settings can be activated by clicking on the text info window in the 3D view.
</div>
### Grids &nbsp;![]({{ site.baseurl }}/images/draw_style_faults_24x24.png)
Toggling **Grids** off will hide the grid cell geometry. This option is used to display geometry for faults and intersections. This feature is also available as a toolbutton called *Hide grid cells*.
### Intersections &nbsp;![]({{ site.baseurl }}/images/CrossSections16x16.png)
Intersections are used to cut the geometry and show result values mapped onto this geometry.
Please refer to [Intersections]({{ site.baseurl }}/docs/intersections) for details.
## Activate items by clicking
Selected overlay items in the 3D view can activate a corresponding item in the **Property Editor**. This is implemented for Info box and result color legends. Please note that this feature is activated by clicking inside the texture/colored part of the legend.
## Eclipse-only features
### Cell Edge Results ![]({{ site.baseurl }}/images/EdgeResult_1.png)

46
docs/ResultInspection.md Normal file
View File

@@ -0,0 +1,46 @@
---
layout: docs
title: Result Inspection
permalink: /docs/resultinspection/
published: true
---
The results mapped on the 3D model can be inspected in detail by left clicking the interesting cells in the 3D view.
The selected cells will be highlighted and text information extracted from the intersection point will be displayed in the docking window **Result Info**.
![]({{ site.baseurl }}/images/ResultInfoWithSelectedCell.png)
If a dynamic result is active, the result values of the selected cells for all time steps are displayed in the docking window **Result Plot** as one curve for each cell.
Additional curves can be added to the plot if CTRL-key is pressed during picking. The different cells are highlighted in different colors, and the corresponding curve is colored using the same color.
![]({{ site.baseurl }}/images/ResultPlotWithSelectedCell.png)
To clear the cell-selection, left-click outside the visible geometry.
<div class="note">
Visibility of the docking widows can be controlled from the <b>Windows</b> menu.
</div>
## Result Info information
Clicking on different type of geometry will display slightly different information as described in the following tables:
### Reservoir model
Geometry | Description
--------------|------------
Reservoir cell| Displays grid cell result value, cell face, grid index and IJK coordinates for the cell. The intersection point coordinates is also displayed. Additional result details are listed in the section **-- Grid cell result details --**
Fault face | Displays the same info as for a *Reservoir cell*. In addition the section **-- Fault result details --** containing Fault Name and Fault Face information.
Fault face with NNC | Displays the same info as *Fault face*, except the Non Neighbor Connections (NNC) result value is displayed instead of grid cell value. Information added in section **-- NNC details --** is geometry information of the two cells connected by the NNC
### Geomechanical model
When clicking in the 3D scene, the selected geometry will be an element.
Name | Description
-----------------------|------------
Closest result | Closest node ID and result value
Element | Element ID and IJK coordinate for the element
Intersection point | Location of left-click intersection of the geometry
Element result details | Lists all integration point IDs and results with associated node IDs and node coordinates

View File

@@ -39,27 +39,39 @@ Tracks and Curves can be organized using drag and drop functionality in the **Pr
All the **Tracks** in the same plot always display the same depth range, and share the *True Veritcal Depth (TVD)* or *Measured Depth (MD)* setting. In the property panel of the plot, the exact depth range can be adjusted along with the depth type setting (TVD/MD).
#### Depth unit
The unit for depth can be set using **Depth unit**, and currently supported units are *Meter* and *Feet*. The first curve added to a plot will set the plot unit based on the curve unit. Additional curves added to a plot will be converted to the plot unit if needed.
#### Depth zoom and pan
The visible depth range can be panned using the mouse wheel while the mouse pointer hovers over the plot.
Pressing and holding Ctrl while using the mouse wheel will allow you to zoom in or out depth-wise, towards the mouse position.
Pressing and holding **CTRL** while using the mouse wheel will allow you to zoom in or out depth-wise, towards the mouse position.
### Track
Tracks can be created by right clicking a **Well Log Plot** and select **New Track**
A track controls the x-axis range of the display, and can be edited from the property panel of the **Track**.
![]({{ site.baseurl }}/images/TrackProperties.png)
A track controls the x-axis range of the display, and can be edited from the property panel of the **Track**.
Logarithmic display is controlled using the **Logarithmic Scale** option.
### Curves
Curves can be created by right clicking a **Track** in the **Project Tree**, or by the commands mentioned above.
There are two types of curves: *Well Log Extraction Curves* and *Well Log LAS Curves*.
Curve visual appearance is controlled in the **Appearance** section:
- **Color** - Controls the color of the curve
- **Thickness** - Number of pixels used to draw the curve
- **Point style** - Defines the style used to draw the result points of the curve, select *None* to disable drawing of points
- **Line style** - Defines the the style used to draw the curve, select *None* to disable line drawing
#### Well Log Extraction Curves
Ectraction curves acts as an artifical well log curve. Instead of probing the real well, a simulation model is probed instead.
They are calculated by intersecting a well trajectory with the cells in a particular grid model. At each intersection point the measured depth along the trajectory is deduced and the corresponding result value is read.
The property panel for a geomechanical model is shown below:
@@ -73,6 +85,13 @@ Placing keyboard focus in the <b>Time Step</b> drop-downbox will allow you to us
The disply name of a curve is normally generated automatically. The options grouped below **Auto Name** can be used to tailor the length and content of the curve name.
##### Curve extraction calculation
Ectraction curves are calculated by finding the intersections between a well trajectory and the cell-faces in a particular grid model. Usually there are two intersections at nearly the same spot; the one leaving the previous cell, and the one entering the next one. At each intersection point the measured depth along the trajectory is interpolated from the trajectory data. The result value is retreived from the corresponding cell in different ways depending on the nature of the underlying result.
For Eclipse results the cell face value is used directly. This is normally the same as the corresponding cell value, but if a **Directional combined results** is used, (See [ Derived Results ]({{ site.baseurl }}/docs/derivedresults) ) it will be that particular face's value.
Abaqus results are interpolated across the intersected cell-face from the result values associated with the nodes of that face. This is also the case for integration point results, as they are directly associated with their corresponding element node in ResInsight.
#### Well Log LAS Curves
LAS-curves shows the values in a particular channel in a LAS-file.

View File

@@ -17,12 +17,15 @@ The command **File -> Import -> Import Well Paths From File** will read the well
The supported ASCII format is quite flexible but the main requirements are:
1. Each data line must contain four numbers: X Y TVD MD separated with white-space.
2. A line starting with none-number-characters are ignored, unless :
2. Lines starting with "--" or "#" is considered to be comment lines
3. A line starting with none-number-characters are used as a well name after the following rules:
1. If the line contains a pair of : ', `, ´, or the text between the quotation marks is used as a well name.
2. If the line contains the case insensitive string "name " the rest of the line is used as a well name.
2. If the line contains the case insensitive string "name" with an optional ":" after, the rest of the line is used as a well name.
3. If there are no quotes or "name"'s, the complete line is used as a well name.
4. If there are several consecutive name-like lines, only the last one will be used
3. If a well name is found, a new well is created and the following data points ends up in it.
### Example 1:
#### Example 1:
WELLNAME: WELL1
4507.0 5638.5 0.0 0.0
@@ -35,21 +38,33 @@ The supported ASCII format is quite flexible but the main requirements are:
5297.4 4938.5 3632.4 1998.387
-999
### Example 2:
#### Example 2:
X Y TVD MD
Name Well_1
5507.0 4638.5 0.0 0.0
5507 4638.5 3628.6 1628.6
5297.4 4938.5 3632.4 1998.387
-- A Comment new well
This is not its name
Name Well_2
5507.0 4638.5 0.0 0.0
5507.0 4638.5 0.0 0.0
5507 4638.5 3628.6 1628.6
# a comment inside the data
5297.4 4938.5 3632.4 1998.387
3Q AHB-J
5507.0 4638.5 0.0 0.0
5507 4638.5 3628.6 1628.6
### Trajectory files are referenced
The trajectory data is not copied into the ResInsight project as such. The project file only stores the file path, and the next time you open the project, ResInsight will try to read the well data from the file again.
<div class="note info">
If the well trajectory file is changed and you would like a running ResInsight to update accordingly, you will need to delete all the well trajectories that emerge from that file, and import it again.
</div>
## Importing from SSI-Hub (Internal Statoil web-service)
In order to import from SSI-Hub, a project file must be present and stored to file. All imported well paths from the web service will be stored relative to this project file location. If no project file exists, the menu item is disabled.