Add well documentation

Author: jonjenssen

assets/images/opm-flow-integration/addnewwell.png

@@ -2,4 +2,46 @@
 title = "Add a New Well"
 
 weight = 40
-+++
++++
+
+### Preparations
+
+ResInsight can be used to create a well path with completions and add a new simulation well based on this to the OPM Flow Job.
+
+To be able to do this you need a grid case loaded that can be used to define the well path as well as read grid results from. 
+
+If you start with just a DATA file, you need to first run the OPM Flow Job without adding any wells to create the grid.
+
+### Define the new well path
+
+First you need a well path to define the well you want to add to your OPM Flow Job. [Create well paths]({{% relref "CreateNewWellPaths" %}}) describes how to do this. You can also create multilaterals as described [here]({{% relref "CreateMultilateralWellPaths" %}}).
+
+You then need to define completions for you new well path. This is described in detail [here]({{% relref "Completions" %}}). Make sure you check the completion settings for the well path, you might need to modify the default values. I.e. the well name set here will be used as the well name in the OPM Flow simulation.
+
+### Add the well to the OPM Flow job
+
+ ![Add New Well - OPM Flow](/images/opm-flow-integration/addnewwell.png)
+
+**Add New Well** Check this option to enable adding a new well to the job.
+
+**Eclipse Case for Well Data** This is the grid case that will be used to extract well data for the new well.
+
+**Well Path for New Well** This defines which well path you want to use for the new well. Both the well path and the completion data will be read from the well selected here.
+
+**Well Group Name** Sets the well group name to be used for the new well. You can enter a new name or use the drop down list to select an already existing group.
+
+**Open Well Keyword** Choose which keyword to use for controlling the well.
+- WCONPROD - for a producer
+- WCONINJE - for an injector
+
+Expand the WCONPROD or WCONINJE sub-group to set the parameters you want to use for the keyword selected. Refer to the OPM Flow manual for more details on these settings.
+
+**Open Well** This setting allows you to choose when you want to open the well using the selected keyword. 
+- *By Date* allows you to select an available date from a drop down list. 
+- *By Position* enables a button that will open a keyword list. You can there use the Up/Down buttons to select the position of the open keyword.
+
+**Restart Simulation at Well Open Date** The availability of this options depends on the input file. If the input is not a restart file, you can select to restart the simulation at the same date the well is set to be opened.
+
+**Include MSW Data** When this option is turn off, only WELSPECS, COMPDAT, COMPLUMP (if set in perforation data) and the selected open keyword are inserted into the DATA file. If you turn on this option, additional MSW keyword will be added. (WELSEGS, COMPSEGS, valves, etc.)
+
+*NOTE*: Some of these options will not be available if your input DATA file does not have DATE keywords (i.e. used TSTEP).

content/opm-flow-integration/AddNewWell.md

@@ -12,13 +12,13 @@ When you select an OPM Flow Job in the Scripts/Jobs project tree, the property e
 
  ### General Group
 
- **Name**: The name used for the job. The name will also be used for the generated DATA file that is sent to OPM Flow when you start the job.
+ **Name**: The name of the job. The name will also be used for the generated DATA file that is sent to OPM Flow when you start the job.
 
  **Input Data File**: Shows the input selected when the job was created. It is a read only setting. If you want to use a different input file, you will have to create a new job.
 
  **Working Folder**: This is the folder where the generated DATA file will be saved, and where the output from the OPM Flow Simulation will we written. It is recommended to not share this folder with other jobs, as this might cause files to be overwritten or corrupted.
 
- **Add Runs to Ensemble**: If this option is turned on (checked), the output from a simulation run will be written into a new sub-folder in the working folder every time you run the job. The first time you run, output will be in "run-0", then "run-1" and so on. The *Advanced* section at the bottom of the properties editor shows you what the next run ID will be and allows you to reset this to 0. 
+ **Add Runs to Ensemble**: If this option is turned on (checked), the output from a simulation run will be written into a new sub-folder in the working folder every time you run the job. The first time you run, output will be in "run-0", then "run-1" and so on. The *Advanced* group at the bottom of the properties editor shows you what the next run ID will be and allows you to reset this to 0. 
 
  Additionally, the output from each run will automatically be added to both grid and summary ensembles in ResInsight, i.e. adding new realizations to ensemble summary plots.
 
@@ -34,9 +34,9 @@ The [Add a new well]({{% relref "AddNewWell" %}}) page describes how to use thes
 
 ![Job Pause - OPM Flow](/images/opm-flow-integration/opmpause.png)
 
-This allows you to manually check and/or edit the generated DATA file in a text editor before OPM Flow is started.
+This allows you to manually check and/or edit the generated DATA file in a text editor before OPM Flow is started. Click *OK* to start the job or *Cancel* to not start it.
 
-**Process Control**, **Simulator Options**, **Solver Settings**, **Comvergense Tolerances**: These groups allows you to control the command line parameters sent to OPM Flow when you run the job. The default settings are read from the [OPM Flow global preferences]({{% relref "OpmFlowPreferences" %}}) when the job is first created.
+**Process Control**, **Simulator Options**, **Solver Settings**, **Convergence Tolerances**: These groups allow you to control the command line parameters sent to OPM Flow when you run the job. The default settings are read from the [OPM Flow global preferences]({{% relref "OpmFlowPreferences" %}}) when the job is first created.
 
 ### Date Settings Group
 

content/opm-flow-integration/JobProperties.md

@@ -24,13 +24,13 @@ ResInsight needs to know where to find the OPM Flow executable. To do this, open
 ![ResInsight Preferences - OPM Flow](/images/opm-flow-integration/preferences.png)
 
 **Path to OPM Flow Executable:**
-Enter the full path of the **flow** executable. Do not add any extra parameters here.
+Enter the full path of the **flow** executable. Do not add any extra parameters here. If you use WSL, it is the full path inside the WSL instance you enter here.
 
 **Use WSL to run OPM Flow:** (Windows only)
 Turn this option on if you want to run OPM Flow using WSL on Windows. In case you have multiple WSL distributions installed, select the one you have flow installed in. 
 
 **Enable MPI:**
-Turn this option on if you want to run OPM Flow in parallel using MPI. You need to enter the full path to the mpirun executable you want to use. Do not add any extra parameters here.
+Turn this option on if you want to run OPM Flow in parallel using MPI. You need to enter the full path to the mpirun executable you want to use. Do not add any extra parameters here. If you use WSL, it is the full path to mpirun inside the WSL instance you enter here.
 
 **Default command line settings:**
 This is where you define the command line parameters you want ResInsight to pass on to OPM Flow. The settings in this section will be the default settings for any new OPM Flow job you create in ResInsight. The settings can be overridden in a particular job, if needed. 

content/opm-flow-integration/OpmFlowPreferences.md

@@ -45,6 +45,20 @@ The log output from an OPM Flow job could be inspected by right clicking the job
 
 Right clicking in the log window gives you the option to select all the text and copy it to the clipboard, so that you could copy it to a text editor for closer inspection.
 
+### On successful runs
+
+If a job has completed successfully, ResInsight will automatically load and display the output from the job.
+
+If *Add to Ensemble* was checked:
+- The summary results from the job will be added to a summary ensemble, and if any existing plots were showing data from the ensemble, the plots will be updated with the new realization added.
+- The grid results from the job will be added to a grid ensemble, and if this is the first time you run the job, a 3D view showing the grid will be added.
+
+If *Add to Ensemble* was not checked:
+- A summary plot will be added for the summary data if this was the first run. 
+- If a plot already was showing data from this job, the data will be reloaded and updated.
+- A 3D grid view will be added for the grid data if none existed. 
+- If a view already was showing the data, the data in the view will be reloaded and updated.
+
 ### Running multiple jobs
 
 ResInsight allows you to run as many jobs as you want at the same time, only limited by the available computing resources.