More OPM Flow job documentation

Author: jonjenssen

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

@@ -0,0 +1,5 @@
++++
+title = "Add a New Well"
+
+weight = 40
++++

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

@@ -8,7 +8,7 @@ weight = 20
 
 ResInsight refers to OPM Flow Simulations as OPM Flow Jobs. They are located in the Scripts/Jobs tree, shown in both the 3D Main Window and the Plot Main Window.
 
-You can create a new job in two ways: From an already loaded grid case or from a .DATA file located on a local or network disk drive. In both cases, ResInsight creates a copy of the provided input in the selected working folder, keeping the original files unmodified.
+You can create a new job in two ways: From an already loaded grid case or from a .DATA file located on a local or network disk drive. In both cases, ResInsight works on a copy of the provided input in the selected working folder, keeping the original files unmodified.
 
 ### Create job from grid case
 
@@ -25,3 +25,8 @@ Go to the Scripts/Jobs tree, right-click on the Jobs folder, and select "New OPM
 You will then be asked to select a working folder, where the job will store all input to and all output from the OPM Flow simulation.
 It is recommended to use an empty folder.
 
+### Duplicate an existing job
+
+If you want to create a copy of an existing job, right click on the existing job in the Scripts/Jobs tree and choose *Duplicate...*
+
+You will be asked for a working folder for the new job. All other settings will be copied over from the existing job.

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

@@ -6,4 +6,48 @@ weight = 30
 
 ### Overview
 
- 
+When you select an OPM Flow Job in the Scripts/Jobs project tree, the property editor allows you adjust the job settings.
+
+ ![Job Properties Overview - OPM Flow](/images/opm-flow-integration/jobproperties.png)
+
+ ### 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.
+
+ **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. 
+ 
+ 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.
+
+### New Well Settings Group
+
+The [Add a new well]({{% relref "AddNewWell" %}}) page describes how to use these settings.
+
+### OPM Flow Group
+
+**Run**: Click the Run button to start the OPM Flow Simulation. Refer to the [Running an OPM Flow Job]({{% relref "RunningOpmFlowJobs" %}}) page for more information about this.
+
+**Pause before running OPM Flow**: When this option is turned on (checked), ResInsight will generate all the input for OPM Flow in the working folder, and then ask the user if the job should be started or not: 
+
+![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.
+
+**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.
+
+### Date Settings Group
+
+![Date Settings - OPM Flow](/images/opm-flow-integration/datesettings.png)
+
+*NOTE*: These settings only works if the input DATA file contains DATE keywords. 
+
+**Stop Simulation at Date**:  If this option is turned on (checked), the simulation will stop at the selected date (an END keyword will be inserted).
+
+**Append Extra Dates**: If this option is turned on (checked), extra dates will be added at the end of the schedule section.
+
+**Number of Dates to Append**: Set how many DATE keywords to append.
+
+**Interval**: The interval in either days or months between each added DATE keyword.

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

@@ -0,0 +1,50 @@
++++
+title = "Running an OPM Flow Job"
+
+weight = 50
++++
+
+### Start the job
+
+Once a job has been properly configured, you can start the job in two ways:
+
+- Right click the job in the Scripts/Jobs tree and choose "Run..."
+- Click the "Run"-button in the OPM Flow group in the job properties
+
+ResInsight will now write the necessary input data for OPM Flow to the selected working directory. The user interface will be blocked while this is done.
+
+Once the input data has been written, ResInsight will launch OPM Flow as specified in the [OPM Flow preferences]({{% relref "OpmFlowPreferences" %}}).
+
+- WSL will be used on Windows if selected
+- MPI will be used if selected
+- The selected command line parameters from the job properites will be added
+
+The resulting command line used to lauch OPM Flow will be shown in the ResInsight *Messages* window.
+
+### Monitor the job progress
+
+Once the OPM Flow process has been started, the ResInsight user interface will unblock, and you can use it as normal. The job properties of the started job will change into a running state, with two items available:
+
+![Run Properties - OPM Flow](/images/opm-flow-integration/jobpropertiesrun.png)
+
+**Working folder**: Shows where the OPM Flow job input and output data files can be found
+
+**Stop**: Allows you to stop the job. You will be asked for confirmation.
+
+![Job Progress - OPM Flow](/images/opm-flow-integration/jobprogress.png)
+
+The Scripts/Jobs tree will show the job progress and the warning count found in the OPM Flow log output. Any line starting with either *Warning* or *Problem* is counted as a warning. 
+
+When the job has completed, *Done* will be shown in the progress field. If the job failed for some reason, the progress field will turn red, and if there are any log lines starting with *Error*, the error count will be shown. There could also be error messages shown in the ResInsight messages window.
+
+### Inspect the OPM Flow log 
+
+![Job Log - OPM Flow](/images/opm-flow-integration/joblog.png)
+
+The log output from an OPM Flow job could be inspected by right clicking the job and selecting *View Log...*. This can be done while the job is running or after it has failed or completed.
+
+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.
+
+### 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.