Merge pull request #21 from OPM/2021-03-updates

2021 03 updates

content/3d-main-window/Filters.md

@@ -1,61 +1,71 @@
 +++
-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
 
-## Range 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 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.
+A new cell filter can be added by invoking the right-click menu for the **Cell Filters** collection in **Project Tree**. 
 
-A new range filter can be added by activating the right-click menu for the **Range Filters** collection in the **Project Tree**. 
+![]({{< relref "" >}}images/3d-main-window/CellFilterTypes.png)
+
+The available cell filters are:
+
+- **Polygon Filters**: Defining a filter by marking target points of a polygon in 3D view to include or exclude matching cells. 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.
+
+- **User Defined Filters**: Defining a filter by specifying explicit cells to include or exclude by their IJK-index.
+
+- **Range Filters**: Defining a filter to include or exclude cells by specifying IJK-ranges. 
+
+- **Slice Filters**: Defining a filter to include or exclude a slice of cells in either I-, J-, or K-direction.
 
 {{% 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.
 

content/3d-main-window/Streamlines.md

@@ -0,0 +1,42 @@
++++
+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.

content/getting-started/ProjectTree.md

@@ -0,0 +1,50 @@
++++
+title = "Project Tree"
+published = true
+weight = 7
++++
+
+![]({{< relref "" >}}images/getting-started/ResInsightPlotProjectTreeAndWindow.png)
+
+As described in [Overview]({{< relref "Overview.md" >}}), ResInsight has two main windows, one for 3D related visualizations and one for 2D graphs and plots. The content and appearance of displayed information is managed and controlled by the **Project Tree** and the **Plot Project Tree**, respectively. This page describes some of their general functionality illustrated by examples using **Plot Project Tree**.
+
+
+## Multiple selection and collective actions
+Multiple selection of items in ResInsight offers an entrance to powerful combinations and collective actions. 
+To exemplify, consider the plot of *Bottom Hole Pressure* for a number of wells atop this page. By multi-selection of wells in **Plot Project Tree**, you may for instance change the color to yellow for all wells with prefix *B* as shown below.
+
+![]({{< relref "" >}}images/getting-started/ResInsightPlotProjectTreeMultiSelectAction.png)
+
+Several options are available for multi selection of items which can be used in combination for efficiency and convenience:
+
+- **Ctrl + left mouse button** for selecting individual items
+
+- **Shift + left mouse button** for selecting a range of consecutive items
+
+- **Item right-click menu**:
+
+  -- **Sub Items On**: select all sub-items of an item in project tree
+
+  -- **Sub Items Off**: deselect all sub-items of an item in project tree
+
+  -- **Toggle Sub Items**: deselect previously selected sub-items and select previously not selected sub-items
+
+![]({{< relref "" >}}images/getting-started/ResInsightPlotProjectTreeItemMenu.png)
+
+
+## Undo and Redo
+ResInsight offers powerful **Undo** and **Redo** functionality. If the user regrets an action, for instance the color setting for multiple wells as exemplified above, the collective action can be undone by pressing **Undo**.
+
+**Undo** and **Redo** is available by: 
+
+- Toolbar icons {{< image-in-text src="images/getting-started//ResInsightPlotProjectTreeToolbarUndoRedo.png" >}}
+- **Edit menu** items **Undo** and **Redo**
+- Shortcuts **Ctrl+Z** and **Ctrl+Y**
+
+
+
+## Context sensitive help
+ResInsight offers context sensitive for any item in project tree. Most convenient is just to press the **F1** help key for any selected item. Alternatively, you may right-click an item (e.g. *Summary Curves*) and the help system will identify the item as subject and perform the actual search for information by menu item **Search Help For**.
+
+![]({{< relref "" >}}images/getting-started/ContextSensitiveHelp.png)
+

content/plot-window/EnsemblePlotting.md

@@ -26,6 +26,12 @@ Ensembles are plotted in the summary plot the same way as ordinary summary curve
 
 Stepping of data source for ensemble curves is described in [Summary Plot Source Stepping]({{< relref "summarysourcestepping" >}})
 
+
+### Resampling
+Resampling of curves is possibly by selecting the actual curve(s) listed by the *Ensemble Curve Sets* item in **Plot Project Tree** and using the **Resampling** feature of **Property Editor**.
+
+![]({{< relref "" >}}images/plot-window/EnsemblePlottingResampling.png)
+
 ### Statistics curves
 If the number of curves in a curve set is sufficient, ResInsight will calculate statistics for the curve set. The following statistics curves may be displayed:
 

content/plot-window/ObjectiveFunctions.md

@@ -0,0 +1,51 @@
++++
+title = "Objective Functions"
+published = true
+weight = 51
++++
+
+![]({{< relref "" >}}images/plot-window/ObjectiveFunctionsPlotColoring.png)
+
+An **Objective Function** is used to color the curves of an ensemble plot in ResInsight to highlight characteristics by a function definition based on individual summary vectors. As shown in the example above, the legend relates colours to values as calculated by a particular objective function and shows the use and formula of the objective function in the plot.
+
+## Using Objective Functions
+
+**Objective Functions** are accessed and activated via the **Plot Project Tree** as shown below. 
+
+![]({{< relref "" >}}images/plot-window/ObjectiveFunctionsPlotProjectTree.png)
+
+ResInsight offers two default objective functions which are readily available to color ensemble plots:
+
+- $ M1(vectors) = \frac{ \Sigma \mid (vectors) \mid }{ stdv } $ for all time steps in selected range (for one or multiple vectors)
+
+- $ M2(vectors) = \Sigma \mid (vectors) \mid $ for all checked time steps (for one or multiple vectors)
+
+
+## Creating Custom Objective Functions
+It is also possible to create a **Custom Objective Function** to customize a formula to color ensemble plots:
+
+- Custom objective functions can express a weighted sum of the default objective functions (applied to any vector)
+
+- Custom objective functions allow for an arbitrary combination of weigthed default objective functions
+
+- Thus, $ M_{custom} = \Sigma_i^N weight_i * f_i(vectors) $ where $ f_i \in \lbrace M1, M2 \rbrace $
+
+A Custom Objective Function is created by invoking the context menu on the **Custom Objective Functions** item in **Plot Project Tree**.
+
+![]({{< relref "" >}}images/plot-window/ObjectiveFunctionsCustomFunction.png)
+
+Composing an objective function by adding a new weighted function is performed by invoking the context menu on the custom objective function and using the property editor.
+
+![]({{< relref "" >}}images/plot-window/ObjectiveFunctionsWeightsNaming.png)
+
+
+## Display settings
+Changing objective function can be performed by the property editor of actual ensemble. The property editor also allows toggling the display of formula by the *Show Formula in Plot* check-box and setting of time step range.
+
+![]({{< relref "" >}}images/plot-window/ObjectiveFunctionsSettings.png)
+
+As seen below, selected range is displayed by color frame and labels in plot background. The range determines the  time range for which the objective function is utilized for coloring the curves.
+
+![]({{< relref "" >}}images/plot-window/ObjectiveFunctionsRangeDisplay.png)
+
+

content/plot-window/SummaryPlots.md

@@ -185,17 +185,18 @@ Having selected a Summary Curve, its properties are shown by the **Property Edit
 
 As seen, the Property Editor organizes the available options into the following groups:
 
-- **Summary Vector** -- Options to select case, vector to plot, axis specification, and error bars.
+- **Summary Vector** -- Options to select case, vector to plot, resampling, axis specification, and error bars.
+- **Stacking** - Options to control stacking of curves optionally with phase colors.
 - **Appearance** -- Options to control curve color, symbols, line style etc.
 - **Curve Name** -- Controls how the curve is labeled in the legend.
 - **Advanced** -- Specification of additional options.
 
 ### Summary Vector
-
 This group of options is used to define summary vector data that the curve will display. 
 
 - **Case** -- Selects the imported Summary or Observed Data case to use as source.
 - **Vector** -- Displays the acronym of the selected vector.
+- **Resampling** - Option to sample curve data per day, week, month, quarter, half year, year, or decade.
 - **Axis** -- Controls whether the curve is to be associated with the left or right Y-Axis. 
 
 Selection of vector is performed using a vector acronym or pressing the button to the right. 
@@ -206,9 +207,7 @@ Switching the Y-Axis for several curves in one go can be done using the right-cl
 {{% /notice %}}
 
 
-
 ### Curve Name 
-
 The user can control the curve name used in the plot legend by the following options:
 
 - **Contribute To Legend** -- This option controls whether the curve will be visible in the plot legend. A curve with an empty name will be removed from legend. 

content/plot-window/VfpPlot.md

@@ -0,0 +1,70 @@
++++
+title = "VFP Plot"
+published = true
+weight = 105
++++
+
+![]({{< relref "" >}}images/plot-window/VFP_Plot.png)
+
+A Vertical Flow Performance Plot (VFP Plot) shows the relationship between bottom hole well conditions and wellhead pressure describing a well's ability to lift fluids to the surface. ResInsight can display both production and injection VFP plots.
+
+## Creating VFP Plots
+VFP Plots are created by right-clicking the **VFP Plots** item in **Plot Project Tree**.
+
+![]({{< relref "" >}}images/plot-window/VFP_PlotNew.png)
+
+## Production VFP Plot
+
+The production VFP Plot shows  the outflow or downstream pressure based on the inlet or upstream pressure and the phases flowing through the system. For a well this means the table relates the flowing bottom-hole pressure
+(*BHP*) to the well's tubing head pressure (*THP*) based on the oil, gas and water rates (and any artificial
+lift quantities like gas lift gas), or phases ratios, flowing up the wellbore. The data is read from files containing the *VFPPROD* Eclipse keyword.
+
+The following is an example of a production VFP Plot and corresponding Property Editor.
+
+![]({{< relref "" >}}images/plot-window/VFP_Production.png)
+
+The available settings of the production Property Editor are:
+
+- **File Path**: The VFP data file(s) to plot. Multi-selection of files is possible.
+
+- **Table Number**: The table number, i.e. VFPTAB keyword in Eclipse data.
+
+- **Reference Depth**: The reference depth used to generate the table, i.e. VFPREF keyword in Eclipse data.
+
+- **Interpolated Variable**: Y-axis variable. 
+
+- **Flowing Phase**: The flowing phase in the system, i.e. FLO keyword in Eclipse data.
+
+- **Flowing Water Fraction**: Corresponds to the WFR keyword in Eclipse data.
+
+- **Flowing Gas Fraction**: Corresponds to the GFR keyword in Eclipse data.
+
+- **Primary Variable**: Variable on X-axis.
+
+- **Family Variable**: Variable for grouping of properties.
+
+- **Fixed Variables**: Used to choose which table to display.
+
+Plot data can be exported by right-clicking the actual plot and selecting *Show Plot Data*.
+
+## Injection VFP Plot
+
+The Injection VFP Plot shows the outflow or downstream pressure based on the inlet or upstream pressure and the phases being injected into the system. For a well this means the table relates the flowing bottom-hole pressure (*BHP*) to the well's tubing head pressure (*THP*) based on the oil, gas or water injection rates. The data can be read from files containing the *VFPINJ* Eclipse keyword.
+
+The following is an example of a production VFP Plot and corresponding Property Editor.
+
+![]({{< relref "" >}}images/plot-window/VFP_Injection.png)
+
+The available settings of the injection VFP Property Editor are:
+
+- **File Path**: The VFP data file(s) to plot. Multi-selection of files is possible.
+
+- **Table Number**: The table number, i.e. VFPTAB keyword in Eclipse data.
+
+- **Reference Depth**: The reference depth used to generate the table, i.e. VFPREF keyword in Eclipse data.
+
+- **Interpolated Variable**: Y-axis variable. 
+
+- **Flowing Phase**: The flowing phase in the system, i.e. FLO keyword in Eclipse data.
+
+Plot data can be exported by right-clicking the actual plot and selecting *Show Plot Data*.