Skip to content

Commit fbb8564

Browse files
committed
Add some OPM Flow Integration docs
1 parent c112a2c commit fbb8564

File tree

6 files changed

+101
-0
lines changed

6 files changed

+101
-0
lines changed
481 KB
Loading
105 KB
Loading
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
+++
2+
title = "Create an OPM Flow Job"
3+
4+
weight = 20
5+
+++
6+
7+
### Overview
8+
9+
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.
10+
11+
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.
12+
13+
### Create job from grid case
14+
15+
Right-click on an already loaded grid case in the 3D Main Window project tree. Select "New OPM Flow Simulation Job...".
16+
You will be asked to select a working folder, where the job will store all input to and all output from the OPM Flow simulation.
17+
It is recommended to use an empty folder.
18+
19+
NOTE: The grid case selected needs to have the related .DATA file located in the same folder as the grid file.
20+
21+
### Create job from .DATA file
22+
23+
Go to the Scripts/Jobs tree, right-click on the Jobs folder, and select "New OPM Flow Simulation Job...". You will be asked to provide the input .DATA file to use.
24+
25+
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.
26+
It is recommended to use an empty folder.
27+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
+++
2+
title = "OPM Flow Job Properties"
3+
4+
weight = 30
5+
+++
6+
7+
### Overview
8+
9+
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
+++
2+
title = "Initial Configuration"
3+
4+
weight = 10
5+
+++
6+
7+
8+
## Install OPM Flow
9+
10+
You need at least version 2025.04 of OPM Flow installed to use it with ResInsight.
11+
12+
Follow the **flow** installation instructions: https://opm-project.org/?page_id=245
13+
14+
## Windows support
15+
16+
To be able to run OPM Flow on your Windows computer, you need to first install **WSL**.
17+
18+
A guide for installing WSL and OPM Flow can be found [here](https://github.com/themilar/OPM-flow-WSL-guide).
19+
20+
## ResInsight setup
21+
22+
ResInsight needs to know where to find the OPM Flow executable. To do this, open the ResInsight preferences:
23+
24+
![ResInsight Preferences - OPM Flow](/images/opm-flow-integration/preferences.png)
25+
26+
**Path to OPM Flow Executable:**
27+
Enter the full path of the **flow** executable. Do not add any extra parameters here.
28+
29+
**Use WSL to run OPM Flow:** (Windows only)
30+
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.
31+
32+
**Enable MPI:**
33+
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.
34+
35+
**Default command line settings:**
36+
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.
37+
38+
NOTE: If you change anything in this section, existing jobs will not be updated. The new settings will only be used by any new jobs you create.
39+
40+
**Process Control:**
41+
Here you can specify the number of MPI processes to run in parallel if MPI has been enabled. You can also adjust the number of threads each process is allowed to use. Using more processes and threads could increase the performance of OPM Flow, but only to certain extent.
42+
43+
Refer to the [OPM Flow manual](https://opm-project.org/?page_id=955) for a description of the remaining parameters.
44+
45+
46+
47+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
+++
2+
title = "OPM Flow Integration"
3+
4+
weight = 90
5+
+++
6+
7+
![OPM Flow Integration overview](/images/opm-flow-integration/overview.png)
8+
9+
ResInsight has support for close integration with the [OPM Flow simulator](https://opm-project.org/?page_id=19). This section shows how you can set up and use OPM Flow with ResInsight.
10+
11+
ResInsight handle OPM Flow simulation runs as "Jobs", allowing you to:
12+
- use input data either from existing grid cases or from data files on disk
13+
- add a new simulation well to an existing simulation
14+
- add more dates to an existing simulation
15+
- control when and how to open the new well
16+
- and more
17+
18+
Both grid results and summary results from a simulation job could be automatically loaded and displayed in ResInsight after a run.

0 commit comments

Comments
 (0)