Skip to content

Commit

Permalink
Merge branch 'next-major-release'
Browse files Browse the repository at this point in the history
  • Loading branch information
magnesj committed Jun 14, 2021
2 parents 880c931 + 0c6fe19 commit 91beb1a
Show file tree
Hide file tree
Showing 155 changed files with 6,132 additions and 4,222 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# ResInsight User Documentation

## Edit of the documentation for Python API
[Edit docs for Python API](docs/README.md)

## Edit documentation
Edit documentation in the folder **content**

Expand Down
21 changes: 21 additions & 0 deletions content/3d-main-window/Annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,27 @@ To import a polyline annotation from file, right click **Annotations** or **Poly
- **File** - Name of the imported file
- **Line Appearance** - Set line color and line thickness

### Polyline File format

Define each point as three double per line (**X Y Depth**). Comment lines are supported by using **#** at the start of the line

```
# This is a comment
# This is a comment
58177.76 732.7 1643.6
58260.83 732.8 1596.6
57985.66 732.7 1542.0
59601.45 732.4 3639.0
59422.01 732.2 3639.0
59793.41 732.2 3639.0
999 999 999
# starting polyline 2
58260.83 732.8 1596.6
57985.66 732.7 1542.0
59601.45 732.4 3639.0
```


## Annotations visibility
Local annotations visibility is controlled by the check boxes in the local annotations sub tree only. Global annotations visibility, on the other hand, is controlled by the check boxes in both the global and local annotations sub trees. So in order to display a global annotation in a specific view, both the annotation tree note itself and its representation in the local sub tree must have visibilty enabled.

Expand Down
2 changes: 2 additions & 0 deletions content/3d-main-window/CellResults.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Difference options are:
- **Difference Case** -- Base case for calculation of difference
- **Base Time Step** -- Base time step for calculation of difference

For [some cell face results]({{< relref "flowvectorresult" >}}#cell-result-view), it is possible to normalize the results by cell face area.

{{% notice note %}}
The difference option is not applicable for TERNARY result display.
{{% /notice %}}
Expand Down
57 changes: 35 additions & 22 deletions content/3d-main-window/Filters.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,74 @@
+++
title = "Cell Filters"
title = "Filters"
published = true
weight = 70
+++

![]({{< relref "" >}}images/3d-main-window/FiltersOverview.png)

Cell Filters are used to control visibility of the cells in the 3D view. Two types of filters exists:
Filters are used to control the visibility of cells in the 3D view. Two types of filters exist:

- **Range Filter** -- Extracts an IJK subset of the model.
- **Property Filter** -- Extracts cells with a property value matching a value range.
- **Cell Filter** -- Extracts subset(s) of grid cells
- **Property Filter** -- Extracts cells with a property value matching a value range

{{% notice note %}}
The visibilities of cells connection to wells, and fences based on these cells can be controlled from <b> <a href="{{< relref "simulationwells" >}}">Simulation Wells</a> </b>.<br>
The visibility of cells connected to wells, and fences can be controlled from <b> <a href="{{< relref "simulationwells" >}}">Simulation Wells</a></b>.<br>
<small><i>(Not applicable for Geomechanical cases)</i></small>
{{% /notice %}}

## Common Properties for Range and Property Filters
## Common Properties Cell and Property Filters

Both filter types can be turned on or off using the toggle in the **Project Tree** and controlled from their corresponding **Property Editor**.
Filters can be turned on and off using their check-boxes in **Project Tree** and controlled by their corresponding **Property Editor**. The sequence of the filters can be rearranged by clicking the arrow icons of selected filter.

![]({{< relref "" >}}images/3d-main-window/FiltersInTreeView.png)

Range Filters and Property filters can either be set to **Include** cells or to **Exclude** them.
Cell Filters and Property filters can either be set to **Include** or **Exclude** the matching cells.
The *Include* setting marks the cells as visible while the *Exclude* setting is used to remove cells from visualization regardless of other filters.
The icon in front of each filter show a + or - sign to indicate *Include* or *Exclude* {{< image-in-text src="images/3d-main-window/FilterIncEx.png" >}}.

The **Exclude** setting is used to explicitly remove cells from the visualization, regardless of what other filters say.
The **Include** setting behaves differently for Range filters and Property Filters but marks the cells as visible.
The icon in front of the filters show a + or - sign to indicate the setting {{< image-in-text src="images/3d-main-window/FilterIncEx.png" >}}
## Cell Filters
Cell Filters enables the user to define a set of visible regions in the 3D view.
Each *Include* cell filter will add cells to the visualization and the resulting 3D view will show the union of all the *Include* cell filters.

## Range filters
A new cell filter can be added by invoking the right-click menu for the **Cell Filters** collection in **Project Tree**.

Range filters enables the user to define a set of visible regions in the 3D view based on IJK boxes.
Each *Include* range filter will *add more cells* to the visualization. The view will show the union of all the *Include* range filters.
![]({{< relref "" >}}images/3d-main-window/CellFilterTypes.png)

A new range filter can be added by activating the right-click menu for the **Range Filters** collection in the **Project Tree**.
The available cell filters are:

- **Polygon Filter**: Defining a filter by marking target points of a polygon in 3D view to include or exclude matching cells.

- **User Defined Filter**: Defining a filter by specifying explicit cells to include or exclude by their IJK-index.

- **Range Filter**: Defining a filter to include or exclude cells by specifying IJK-ranges.

- **Slice Filter**: Defining a filter to include or exclude a slice of cells in either I-, J-, or K-direction.

The following exemplifies the use of a **Polygon Filter** and target points. Target points are defined and manipulated in 3D view as decribed in [User Defined Polyline Annotations]({{< relref "Annotations.md" >}}). Vertically, the filter can be set to use the XY target positions or IJK-index of targeted cells. The actual filtering can be specified to whole cells inside polygon, cell center inside polygon, or any cell corner inside polygon.

![]({{< relref "" >}}images/3d-main-window/CellFilter_Polygon.png)

{{% notice note %}}
An I,J or K-slice range filter can be added directly from a Cell in the <b>3D View</b> by right-clicking the cell and using the right-click menu.
A filter can be added directly from <b>3D View</b> by right-clicking a cell using the displayed menu.
{{% /notice %}}

Below is a snapshot of the **Property Editor** of the **Range Filter** :
Below is a snapshot of the **Property Editor** for the **Range Filter** type of Cell Filter:

![]({{< relref "" >}}images/3d-main-window/RangeFilterProperties.png)

- **Filter Type** -- The filter can either make the specified range visible ( *Include* ), or remove the range from the View ( *Exclude* ).
- **Grid** -- This option selects which of the grids the range is addressing.
- **Apply to Subgrids** -- This option tells ResInsight to use the visibility of the cells in the current grid to control the visibility of the cells in sub-LGR's. If this option is turned off, Sub LGR-cells is not included in this particular Range Filter.

The **Start** and **Width** labels in front of the sliders features a number in parenthesis denoting maximum available value.<br>
The **Start** labels shows the index of the start of the active cells.<br>
The **Width** labels shows the number of active cells from the start of the active cells.
The **Start** and **Width** labels in front of the sliders features a number in parenthesis denoting maximum available value.
The **Start** labels show the index of the start of the active cells.
The **Width** labels show the number of active cells from the start of the active cells.

## Property Filters

**Property Filters** applies to the results of the **Range Filters** and limits the visible cells to the ones approved by the filter. For a cell to be visible it must be accepted by all the property filters.
**Property Filters** applies to the results of the **Cell Filters** and limits the visible cells to the ones approved by the filter. For a cell to be visible it must be accepted by all property filters.

A new property filter can be made by activating the right-click menu on **Property Filters** or by right-clicking inside a 3D view. The new property filter is based on the currently viewed cell result by default.
A new property filter is created by activating the right-click menu on **Property Filters** or by right-clicking inside a 3D view. The new property filter is based on the currently viewed cell result by default.

The name of the property filter is automatically set to *"propertyname (min .. max)"* as you edit the property filter.

Expand Down
69 changes: 30 additions & 39 deletions content/3d-main-window/FlowVectorResult.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,62 @@
+++
title = "Flow Vector Result"
title = "Flow Results"
published = true
weight = 50
+++

![]({{< relref "" >}}images/3d-main-window/FlowVectorResult.PNG)

The Flow Vector Result View lets the user investigate fluxes by visualizing flow vectors in the reservoir. It allows for selecting and combining different fluids and directions. Selected vectors can be combined and scaled.
Flow Results lets the user investigate flow properties and fluxes in a reservoir, e.g. by flow vector visualizations selecting and combining different fluids and directions.

The flow vectors are based on the Eclipse properties **FLRGASI/J/K FLRWATI/J/K FLROILI/J/K**
## Flow Vectors
Flow vectors are computed based on the Eclipse properties **FLRGASI/J/K FLRWATI/J/K FLROILI/J/K**.
Visualization of flow vector results always use velocity instead of rate. Velocity is computed as flow rate divided by cell face area.

### Open the Flow Vector Result View

In order to show Flow Vector Results, select and check the checkbox next to **Flow Vector Result** in the **Project Tree**.
In order to show flow vectors, check the checkbox next to **Flow Vector Result** in **Project Tree**.

![]({{< relref "" >}}images/3d-main-window/FlowVectorResultMenu.PNG)

The 3D View gets updated with arrows visualizing the fluxes. The directions, data source fluids, color, scale and threshold can be adjusted in the Property Editor.
This updates the 3D View with arrows visualizing the fluxes for the given time step or animation. The directions, data source fluids, color, scale and threshold can be adjusted in the Property Editor.

### Legend
The legend in 3D View maps the Flow Vector colors to their respective result values. By default it shows the max values for all time steps. The legend settings can be changed in the **Color Legend** sub item of the **Flow Vector Result** item in **Project Tree**.

![]({{< relref "" >}}images/3d-main-window/FlowVectorResultLegend.PNG)

The legend maps the Flow Vector colors to their respective result values. By default it shows the max values for all time steps. The legend settings can be changed in the **Color Legend** sub item of the **Flow Vector Result** item in the **Project Tree**.

**Note:**\
When combining several fluids, the max value shown in the legend is an aggregation of the single max values of each selected fluid. This means that this number might be higher than the result of any flow vector.
{{% notice note %}}
When combining several fluids, the max value shown in legend is an aggregation of the single max values of each selected fluid. This means that this number might be higher than the result of any flow vector.
{{% /notice %}}


### Adjust the View

In the *Property Editor*, there are four different settings groups.
## Flow Vector Settings

![]({{< relref "" >}}images/3d-main-window/FlowVectorResultProperties.PNG)

#### Fluids
The fluxes of the fluids selected here are shown as aggregated vectors in the 3D view.
The Property Editor controls the following settings:

- **Fluids**: Selection of fluids for displaying fluxes as aggregated vectors in 3D view.

#### Visibility
- **Visibility**

**View Vectors**
- **Per Face:** Show one flow vector per cell face. Each direction has its own vector.
- **Cell Center Total:** Show only one vector per cell, located at the cell's center position. This vector is an aggregation of all single direction vectors.
-- **View Vectors**: Select *Per Face* to show one flow vector per cell face or *Cell Center Total* to show only one vector per cell center (as an aggregation of all single direction vectors).

**Vectors Touching Surface** (only enabled when **View vectors** is set to **Per Face**)
- **At vector anchor:** The vectors are starting at the cells' faces.
- **At vector center:** The vectors' centers are located at the cell's faces.
-- **Vectors Touching Surface**: Select *At Vector Anchor* to display vectors starting at cell faces or *At Vector Center* to center vectors at cell faces.
*Vectors Touching Surface* is enabled when *View vectors* is set to *Per Face*.

**I/J/K**
- Use flows in **I/J/K** direction for computing vectors.
-- **I/J/K**: Use flows in I/J/K direction for computing vectors.

**Show NNC data**
- Visualize flows between non-neighbouring cells.
-- **Show NNC data**: Visualize flows between non-neighbouring cells.

**Threshold**
- All vectors with flow result values below this number are hidden.
-- **Threshold**: All vectors with flow result values below this number are hidden.

#### Vector Colors
- **Result Colors:** Color vectors in the flow result color according to the *Element Vector Result* legend shown in the 3D View.
- **Uniform:** Color vectors in a uniform color.
- **Appearance**: Select *Result Colors* to color vectors according to *Element Vector Result* legend in 3D View or *Uniform* for uniform color. Use *Size Scale* to scale vector length.

#### Vector Size

## Cell Result View
ResInsight may visualize intercell flows, flow rates, and transmissibilities as *Cell Results* optionally divided by face area, c.f. check-box *Divide By Area* below.
For instance, the option enables comparison of horisontal and vertical flow velocities as alternative to flow rates as the latter is typically influenced by significant differences in cell face areas.

**Size Scale**
- Scales the length of the vectors by this value.
![]({{< relref "" >}}images/3d-main-window/FlowRateCellResultAndLegend.png)

**Scale Method**
- **Result:** Scale the vectors according to their flow result value.
- **Result (logarithmically):** Scale the vectors according to their flow result value but in a logarithmic scale. **Note:** all values are increased by 1 in order to be able to properly show flow result values smaller than 1.*
- **Constant:** All vectors have the same constant length.
Specifically, the check-box *Divide By Area* is applicable to Eclipse properties *FLROIL, FLRGAS, FLRWAT, FLOOIL, FLOGAS, FLOWAT*, and transmissibilities *TRAN* and *riTRAN*.
These results are listed in ResInsight postfixed by *IJK+-* or *XYZ* as shown above. As seen, checking *Divide By Area* is reflected by text */A* in legend.
54 changes: 54 additions & 0 deletions content/3d-main-window/Streamlines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
+++
title = "Streamlines"
published = true
weight = 50
+++

![]({{< relref "" >}}images/3d-main-window/Streamlines.png)

Streamlines lets the user investigate the flow of different phases through a reservoar. It allows for selecting both an individual phase or a combination of phases colored by the dominant phase or velocity. The visualization and animation of streamlines requires the Eclipse properties **FLRGASI/J/K FLRWATI/J/K FLROILI/J/K**.

## Displaying Streamlines

To display streamlines, select a time step and check the **Streamlines** checkbox in **Project Tree**.

![]({{< relref "" >}}images/3d-main-window/StreamlinesProjectTreeCheckBox.png)


## Property Editor
The display and animation of streamlines is controlled by the **Property Editor**.

![]({{< relref "" >}}images/3d-main-window/StreamlinesPropertyEditor.png)

The following groups of settings control the content, display and animation of streamlines:

**Data Selection**
- **Phase**: Selection of an individual phase (*Oil*, *Gas*, *Water*) or *Combined* display.
- **Flow Threshold**: Minimum flow threshold calculated as I/J/K flow rate divided by corresponding face area.
- **Minimum Length**: Minimum length of streamlines in meters.
- **Resolution**: Resolution of streamline animation in days (governing the number of individual animation steps).
- **Max Days**: Maximum calculation range in days for streamline animation.

**Well Selection**
- **Injector Wells**: Calculate streamlines stemming from injector wells.
- **Producer Wells**: Calculate streamlines backtracing from producer wells.

**Visualization Settings**
- **Visualization Mode**: Perform an animation of streamlines or manually control the display.
- **Colors**: Color the streamlines by dominant phase or by velocity.
- **Animation Speed**: Adjust the speed of streamline animation.
- **Tracer Length**: Adjust the length of the individual tracers pertinent to a streamline.

In case **Visualization Mode** is set to **Manual control**, the setting **Animation Index** replaces the two latter settings. **Animation Index** allows for displaying an individual animation step.


## Algorithm in brief
Streamlines are generated by starting in open injector well cells and tracing out through the face with the largest flow rate (in m/day) into the next cell and so on. If flow rates above the given threshold exists for multiple cell faces, additional trace branches are spawned off for those faces. The distance between each point added to a trace is controlled by the resolution, as $ distance = rate * resolution $. The trace ends when either:

- the flow goes below the user specified threshold
- the maximum number of days since the start of the trace have been reached
- a cell that already has a trace in it is encountered
- an active well cell is encountered

Streamlines could also be generated using production wells as starting cells. In that case, the flow is reversed and the flow is traced backwards from the starting well using the same algorithm as for injector wells. Once reaching the end, the trace is reversed again to have the flow go into the production well in the final streamline.

26 changes: 26 additions & 0 deletions content/Wells-and-Completions/CreateMultilateralWellPaths.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
+++
title = "Create Multilaterals Well Paths"
published = true
weight = 32
+++

![]({{< relref "" >}}images/3d-main-window/MultiLateralWell_3d_view.png)

ResInsight lets the user create additional well path laterals by clicking in the 3D view. Completions can be added to laterals, and the complete specification of the well can
be exported using the [Completion Export]({{< relref "completionexport" >}})

### Building a well path

1. Start from an existing well path, either imported or [create a new well path]({{< relref "createnewwellpaths" >}})
2. In the 3D view, right-click on the well path at the depth location for your lateral
![]({{< relref "" >}}images/3d-main-window/MultiLateralWell_create.png)
3. A new well path lateral is created, and click in the 3D scene to define targets for the lateral
4. Repeat from 2. for more laterals

### Tie In Control
The parent well and the measured depth of the tie in location can be adjusted from the property editor.

![]({{< relref "" >}}images/3d-main-window/MultiLateralWell_property_editor.png)

### Naming of laterals
When a lateral is created, the postfix **Y1** is added to the original well path. The first lateral is given the postfix **Y2**. See the image above for an example of naming.
12 changes: 1 addition & 11 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,6 @@ published = true

![]({{< relref "" >}}images/FrontPageImage.png)

<!--
<section class="intro">
<div class="grid">
<div class="unit whole center-on-mobiles">
<p class="first">Post Processing of Reservoir Simulations</p>
</div>
<div class="post-content">
<img src="{{< relref "" >}}images/FrontPageImage.png" alt="Reservoir" />
</div>
</div>
</section> -->
<section class="features">
<div class="grid">
<div class="unit one-third">
Expand All @@ -29,6 +18,7 @@ published = true
&#x2713; Handles large Eclipse cases<br>
&#x2713; Plotting of summary vectors<br>
&#x2713; Embedded Flow Diagnostics<br>
&#x2713; Python API for scripting<br>
</p>
</div>
<div class="unit one-third">
Expand Down

0 comments on commit 91beb1a

Please sign in to comment.