+Configuration fileOverview or run pycopm -h for the definition -of the argument options, and the examples.) +of the argument options, as well as the examples in Via OPM Flow decks.)
Here we use as an example one of the configuration files used in the tests (see ert.txt). diff --git a/docs/examples.html b/docs/examples.html index b98f74a..a281f99 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -51,14 +51,13 @@
Examples
Via configuration files
-Drogon
The examples folder contains configuration files -to perform HM studies in drogon and norne. For example, by executing inside the example folder for drogon:
+to perform HM studies in drogon and norne using ERT. For example, by executing inside the example folder for drogon:pycopm -i coarser.txt -o drogon_coarser
Drogon<
-
For norne:
+pycopm -i input.txt -o norne_coarser
+The norne GIF in the introduction was generated using the generated coarse model.
Via OPM Flow decks
+Via OPM Flow decks
+The current development of pycopm focuses on only creating coarser models (i.e., all needed input files to run OPM Flow) by using the input deck.
+Hello world
+For the HELLO_WORLD.DATA deck, by executing:
+pycopm -i HELLO_WORLD.DATA -c 5,1,5 -m all
+This would generated the following:
+
+Dry run from the input cloned deck (left) and (right) coarsed model. Adding the flag -p 1 adds the remove pore volume to the neighbouring cells.
+To make active the coarse cell where there is only one active cell, this can be achieve by:
+pycopm -i HELLO_WORLD.DATA -c 5,1,5 -m all -a max
+
+Dry run from the input cloned deck (left) and (right) coarsed model. The region numbers by default are given by the mode, e.g., use the flag -n max to keep the maximum integer.
+SPE10
-See/run the test_generic_deck.py -for an example where pycopm is used to coarse the -SPE10_MODEL2 model by downloading the OPM files and running:
+By downloading the SPE10_MODEL2 model, then:
pycopm -i SPE10_MODEL2.DATA -o coarser -c 4,8,2
Porosity values for the (left) original and (right) coarsed SPE10 model.
+Porosity values for the (left) original and (right) coarsed SPE10 model.
SPE10Smeaheia
By downloading the Smeaheia simulation model, then:
-pycopm -i Statoil_Feasibility_sim_model_with_depletion_KROSS_INJ_SECTOR_20.DATA -o . -c 5,4,3 -a mode
-will generate a coarser model 5 times in the x direction, 4 in the y direction, and 3 in the z direction, where the mode is -used to decide if a coarser cell should be active or inactive.
-We can execute a dry run of OPM Flow to generate the grid and static variables of the coarser model:
-flow STATOIL_FEASIBILITY_SIM_MODEL_WITH_DEPLETION_KROSS_INJ_SECTOR_20_PYCOPM.DATA --enable-dry-run=true
+pycopm -i Statoil_Feasibility_sim_model_with_depletion_KROSS_INJ_SECTOR_20.DATA -o . -c 5,4,3 -a min -m all
+will generate a coarser model 5 times in the x direction, 4 in the y direction, and 3 in the z direction, where the coarse cell is
+made inactive if at least one cell is inactive (-a min).
We use our plopm friend to generate PNG figures:
-plopm -i STATOIL_FEASIBILITY_SIM_MODEL_WITH_DEPLETION_KROSS_INJ_SECTOR_20_PYCOPM -s ,,0
+plopm -i ' STATOIL_FEASIBILITY_SIM_MODEL_WITH_DEPLETION_KROSS_INJ_SECTOR_20_PREP_PYCOPM_DRYRUN STATOIL_FEASIBILITY_SIM_MODEL_WITH_DEPLETION_KROSS_INJ_SECTOR_20_PYCOPM' -s ,,0 -v poro -subfigs 1,2 -save smeaheia -t 'Smeaheia Coarsed smeaheia' -xunits km -xformat .0f -yunits km -yformat .0f -d 5,5.2 -suptitle 0 -c cet_rainbow_bgyrm_35_85_c69 -cbsfax 0.30,0.01,0.4,0.02 -cformat .2f
-
+
-Porosity values for the (left) original and (right) coarsed model.
+Top view of porosity values for the (left) original and (right) coarsed model (note that we also coarse on the z direction).
@@ -161,30 +181,44 @@ Smeaheia
where these properties are define via include files, replace those includes in the .DATA deck with the actual content of the include files.
-
-Generic Drogon
+
+Drogon
Following the note above, then by downloading the DROGON model, replacing the lines in
DROGON_HIST.DATA for the FAULTS (L127-128) and SCHEDULE (L242-243) with
the actual content of those include files, then by executing:
-pycopm -i DROGON_HIST.DATA -o . -c 1,1,3 -a min -n max -p 1
-pycopm -i DROGON_HIST_PYCOPM.DATA -o . -c 1,3,1 -a mode -n mode -p 1 -j 1.9
+pycopm -i DROGON_HIST.DATA -c 1,1,3 -p 1
+pycopm -i DROGON_HIST_PYCOPM.DATA -c 1,3,1 -p 1 -j 2.5
this would generate the following coarse model:
-
+
-Note that the total pore volume is conserved for the coarse model.
+Note that the total pore volume is conserved for the coarse model.
Here, we first coarse in the z direction, which reduces the number of cells from 31 to 11, and after we coarse in the y direction.
-After trial and error, the jump (-j) is set to 1.9 to avoid generated connections across the faults.
+After trial and error, the jump (-j) is set to 2.5 to avoid generated connections across the faults. For geological models with a lot of
+inactive cells and faults, this divide and conquer apporach is recommended, i.e., coarsening first in the z directon and after coarsening
+in the x and y directions.
Note
-After genereting the first coarser deck (DROGON_HIST_PYCOPM.DATA), change the path ‘../include/props/drogon.swatinit’ to ‘SWATINIT.INC’,
-which contains the right number of values for the coarse model.
+Add to the generated coarse deck the missing include files in the grid section related to the region operations (e.g.,
+../include/grid/drogon.multregt for this case).
+
+Norne
+By downloading the Norne model (and replacing the needed include files as described in the previous
+example), then here we create a coarser model by removing certain pilars in order to keep the main features of the geological model:
+pycopm -i NORNE_ATW2013.DATA -x 0,2,0,2,2,0,2,0,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,0,2,0,2,2,0,2,2,0,2,2,2,2,0 -y 0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,0,2,0,2,0,2,0,2,0,2,0,2,0,2,0,2,2,2,2,2,2,2,2,2,0 -z 0,0,2,0,0,2,2,2,2,2,02,2,2,2,2,0,0,2,0,2,2,0,0,0,0,0,0,0,0,0,0 -a min -p 1
+
+
+this would generate the following coarse model:
+
+
+
+
diff --git a/docs/genindex.html b/docs/genindex.html
index ca1cca7..7e96213 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -180,13 +180,17 @@ H
handle_fault() (in module pycopm.utils.generate_coarser_files)
-
-
- handle_grid_props() (in module pycopm.utils.generate_coarser_files)
- handle_mapaxes() (in module pycopm.utils.generate_coarser_files)
+
+ - handle_oper() (in module pycopm.utils.generate_coarser_files)
+
+ - handle_props() (in module pycopm.utils.generate_coarser_files)
- handle_pv() (in module pycopm.utils.generate_coarser_files)
diff --git a/docs/index.html b/docs/index.html
index a4b0abc..d2e2a42 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -101,14 +101,13 @@ Welcome to pycopm’s documentation!Configuration file
- Examples
diff --git a/docs/introduction.html b/docs/introduction.html
index 9e5e5ed..b3059f3 100644
--- a/docs/introduction.html
+++ b/docs/introduction.html
@@ -96,8 +96,8 @@
Concept
Roadmap
-In the initial development of the framework, the focus was two available models in opm-tests: norne
-and drogon, where the coarser models are used to perform history matching studies using
+
In the initial development of the framework, the focus were two available models in opm-tests: norne
+and drogon, where the coarser models were used to perform history matching studies using
the Ensemble based reservoir tool ERT, via a configuration file.
The current development of pycopm focuses on only creating coarser models (i.e., all needed input files to run OPM Flow) by only giving the OPM Flow input files
(i.e., avoiding the manual work to create templates as it was done for drogon and norne). This allows for flexibility to adapt the generated coarser decks in your
@@ -121,13 +121,7 @@
Roadmap
OPM Flow full path to executable or just flow (flow by default).
- -c
-Level of coarsening in the x, y, and z dir (2,2,2 by default).
-- -a
-Use min, max, or mode to scale the actnum, e.g., min makes the new coarser cell inactive it at least one cell is inactive, while max makes it active it at least one cell is active (max by default).
-- -j
-Tuning parameter to avoid creation of neighbouring connections in the coarser model where there are discontinuities between cells along the z direction, e.g., around faults (’’ by default, i.e., nothing corrected; if need it, try with values of the order of 1).
+Level of coarsening in the x, y, and z dir (2,2,2 by default; either use this flag or the -x, -y, and -z ones).
- -x
Vector of x-coarsening, e.g., if the grid has 6 cells in the x direction, then 0,2,0,2,0,2,0 would generate a coarser model with 3 cells, while 0,2,2,2,2,2,0 would generate a coarser model with 1 cell, i.e., 0 keeps the pilars while 2 removes them (’’ by default),
@@ -138,17 +132,35 @@ Roadmap
- -z
Vector of z-coarsening, see the description for -x (’’ by default).
- -e
-Use utf8 or ISO-8859-1 encoding to read the deck (ISO-8859-1 by default).
+- -a
+Use min, max, or mode to scale the actnum, e.g., min makes the new coarser cell inactive if at least one cell is inactive, while max makes it active it at least one cell is active (mode by default).
+- -n
+Use min, max, or mode to scale endnum, eqlnum, fipnum, fluxnum, imbnum, miscnum, multnum, pvtnum, rocknum, and satnum (mode by default).
+- -s
+Use min, max, or mean to scale permx, permy, permz, poro, swatinit, and all mult(-)xyz (’’ by default, i.e., using the arithmetic average for permx/permy, harmonic average for permz, and the mean for the rest).
- -p
Add the removed pore volume to the closest coarser cells (0 by default, 1 to enable).
- -n
-Use min, max, or mode to scale satnum, fipnum, pvtnum, eqlnum, imbnum, and multnum (mode by default).
+- -j
+Tuning parameter to avoid creation of neighbouring connections in the coarser model where there are discontinuities between cells along the z direction, e.g., around faults (’’ by default, i.e., nothing corrected; if need it, try with values of the order of 1).
- -s
-Use min, max, or mean to scale permx, permy, permz, and poro (’’ by default, i.e., using the arithmetic average for permx/permy, harmonic average for permz, and the mean for the porosity).
+- -m
+Execute a dry run on the input deck to generate the static properties (‘prep’), generate only the coarse files (‘deck’), only exectute a dry run on the generated coarse model (‘dry’), ‘prep_deck’, ‘deck_dry’, or do all (‘all’) (prep_deck by default).
+- -w
+Name of the generated deck (’’ by default, i.e., the name of the input deck plus _PYCOPM.DATA).
+- -l
+Added text before each generated .INC (PYCOPM_ by default, i.e., the coarse porv is saved in PYCOPM_PORV.INC; set to ‘’ to generate PORV.INC, PERMX.INC, etc).
+- -e
+Use utf8 or ISO-8859-1 encoding to read the deck (ISO-8859-1 by default).
+- -ijk
+Given i,j,k indices in the input model, return the coarse i,j,k corresponding positions (’’ by default; if not empty, e.g., 1,2,3 then the -m is set to deck and there will not be generation of coarse files, only the i,j,k coarse indices in the terminal).
diff --git a/docs/objects.inv b/docs/objects.inv
index 012d960..aab696b 100644
Binary files a/docs/objects.inv and b/docs/objects.inv differ
diff --git a/docs/output_folder.html b/docs/output_folder.html
index 81b7066..17af0bd 100644
--- a/docs/output_folder.html
+++ b/docs/output_folder.html
@@ -106,7 +106,7 @@ Via configuration files
Via an OPM Flow input deck
-The current development of pycopm focuces on only creating coarser models (i.e., all needed input files to run OPM Flow) by only giving the OPM Flow input files.
+The current development of pycopm focuces on only creating coarser models (i.e., all needed input files to run OPM Flow) by using the input deck.
The following screenshot shows the input deck and generated files in the selected output folder (coarser for this example) after executing pycopm on the SPE10 model (see the
test_generic_deck.py) file.
@@ -114,6 +114,13 @@ Via an OPM Flow input deckERT, PET, everest).
+
+Note
+For input decks that include other files without giving the full path (e.g., ‘./include/summary…’), then we recommend
+to use the default output folder (-o .), i.e., the generated deck and coarse files would be generated in the same location as
+the input deck and no errors would appear for not finding the include files; otherwise, you might need to copy all needed folders
+with the include files to the output folder or setting the correct path to the include files in the generated coarse deck.
+
diff --git a/docs/pycopm.html b/docs/pycopm.html
index 3162b03..d8dfb73 100644
--- a/docs/pycopm.html
+++ b/docs/pycopm.html
@@ -120,6 +120,8 @@ Subpackageshandle_fault()
handle_grid_props()handle_mapaxes()handle_oper()handle_props()handle_pv()handle_regions()handle_segmented_wells()
+-
+pycopm.utils.generate_coarser_files.handle_oper(dic, nrwo)
+We also support operations
+
+- Args:
dic (dict): Global dictionary
+nrwo (list): Splited row from the input deck
+- Returns:
dic (dict): Modified global dictionary
+
+
+
+
+-
+pycopm.utils.generate_coarser_files.handle_props(dic, nrwo)
+Handle the props sections
+
+- Args:
dic (dict): Global dictionary
+nrwo (list): Splited row from the input deck
+- Returns:
dic (dict): Modified global dictionary
+
+
+
-
pycopm.utils.generate_coarser_files.handle_pv(dic, clusmin, clusmax, rmv)
diff --git a/docs/pycopm.utils.html b/docs/pycopm.utils.html
index 190b915..f32e2dc 100644
--- a/docs/pycopm.utils.html
+++ b/docs/pycopm.utils.html
@@ -106,6 +106,8 @@ Submoduleshandle_fault()
handle_grid_props()handle_mapaxes()handle_oper()handle_props()handle_pv()handle_regions()handle_segmented_wells()`_ folder contains configuration files
-to perform HM studies in drogon and norne. For example, by executing inside the `example folder for drogon `_:
+to perform HM studies in drogon and norne using `ERT `_:
.. code-block:: bash
@@ -20,17 +17,50 @@ The following are the drogon model from `opm-tests ` was generated using the generated coarse model.
+
+.. _generic:
==================
Via OPM Flow decks
==================
+The current development of **pycopm** focuses on only creating coarser models (i.e., all needed input files to run OPM Flow) by using the input deck.
+
+Hello world
+-----------
+For the `HELLO_WORLD.DATA `_ deck, by executing:
+
+.. code-block:: bash
+
+ pycopm -i HELLO_WORLD.DATA -c 5,1,5 -m all
+
+This would generated the following:
+
+.. figure:: figs/hello_world_1.png
+
+ Dry run from the input cloned deck (left) and (right) coarsed model. Adding the flag -p 1 adds the remove pore volume to the neighbouring cells.
+
+To make active the coarse cell where there is only one active cell, this can be achieve by:
+
+.. code-block:: bash
+
+ pycopm -i HELLO_WORLD.DATA -c 5,1,5 -m all -a max
+
+.. figure:: figs/hello_world_2.png
+
+ Dry run from the input cloned deck (left) and (right) coarsed model. The region numbers by default are given by the mode, e.g., use the flag -n max to keep the maximum integer.
+
SPE10
-----
-See/run the `test_generic_deck.py `_
-for an example where **pycopm** is used to coarse the
-`SPE10_MODEL2 model `_ by downloading the OPM files and running:
+By downloading the `SPE10_MODEL2 model `_, then:
.. code-block:: bash
@@ -48,26 +78,20 @@ then:
.. code-block:: bash
- pycopm -i Statoil_Feasibility_sim_model_with_depletion_KROSS_INJ_SECTOR_20.DATA -o . -c 5,4,3 -a mode
-
-will generate a coarser model 5 times in the x direction, 4 in the y direction, and 3 in the z direction, where the mode is
-used to decide if a coarser cell should be active or inactive.
+ pycopm -i Statoil_Feasibility_sim_model_with_depletion_KROSS_INJ_SECTOR_20.DATA -o . -c 5,4,3 -a min -m all
-We can execute a dry run of OPM Flow to generate the grid and static variables of the coarser model:
-
-.. code-block:: bash
-
- flow STATOIL_FEASIBILITY_SIM_MODEL_WITH_DEPLETION_KROSS_INJ_SECTOR_20_PYCOPM.DATA --enable-dry-run=true
+will generate a coarser model 5 times in the x direction, 4 in the y direction, and 3 in the z direction, where the coarse cell is
+made inactive if at least one cell is inactive (-a min).
We use our `plopm `_ friend to generate PNG figures:
.. code-block:: bash
- plopm -i STATOIL_FEASIBILITY_SIM_MODEL_WITH_DEPLETION_KROSS_INJ_SECTOR_20_PYCOPM -s ,,0
+ plopm -i ' STATOIL_FEASIBILITY_SIM_MODEL_WITH_DEPLETION_KROSS_INJ_SECTOR_20_PREP_PYCOPM_DRYRUN STATOIL_FEASIBILITY_SIM_MODEL_WITH_DEPLETION_KROSS_INJ_SECTOR_20_PYCOPM' -s ,,0 -v poro -subfigs 1,2 -save smeaheia -t 'Smeaheia Coarsed smeaheia' -xunits km -xformat .0f -yunits km -yformat .0f -d 5,5.2 -suptitle 0 -c cet_rainbow_bgyrm_35_85_c69 -cbsfax 0.30,0.01,0.4,0.02 -cformat .2f
.. figure:: figs/smeia.png
- Porosity values for the (left) original and (right) coarsed model.
+ Top view of porosity values for the (left) original and (right) coarsed model (note that we also coarse on the z direction).
.. tip::
You can install plopm by executing in the terminal: pip install git+https://github.com/cssr-tools/plopm.git.
@@ -77,16 +101,16 @@ We use our `plopm `_ friend to generate PNG
(e.g., FAULTS, WELLSPECS) are assumed to be define in the main .DATA deck. Then, in order to use **pycopm** for simulation models
where these properties are define via include files, replace those includes in the .DATA deck with the actual content of the include files.
-Generic Drogon
---------------
+Drogon
+------
Following the note above, then by downloading the `DROGON model `_, replacing the lines in
`DROGON_HIST.DATA `_ for the FAULTS (L127-128) and SCHEDULE (L242-243) with
the actual content of those include files, then by executing:
.. code-block:: bash
- pycopm -i DROGON_HIST.DATA -o . -c 1,1,3 -a min -n max -p 1
- pycopm -i DROGON_HIST_PYCOPM.DATA -o . -c 1,3,1 -a mode -n mode -p 1 -j 1.9
+ pycopm -i DROGON_HIST.DATA -c 1,1,3 -p 1
+ pycopm -i DROGON_HIST_PYCOPM.DATA -c 1,3,1 -p 1 -j 2.5
this would generate the following coarse model:
@@ -95,8 +119,23 @@ this would generate the following coarse model:
Note that the total pore volume is conserved for the coarse model.
Here, we first coarse in the z direction, which reduces the number of cells from 31 to 11, and after we coarse in the y direction.
-After trial and error, the jump (-j) is set to 1.9 to avoid generated connections across the faults.
+After trial and error, the jump (-j) is set to 2.5 to avoid generated connections across the faults. For geological models with a lot of
+inactive cells and faults, this divide and conquer apporach is recommended, i.e., coarsening first in the z directon and after coarsening
+in the x and y directions.
.. note::
- After genereting the first coarser deck (DROGON_HIST_PYCOPM.DATA), change the path '../include/props/drogon.swatinit' to 'SWATINIT.INC',
- which contains the right number of values for the coarse model.
\ No newline at end of file
+ Add to the generated coarse deck the missing include files in the grid section related to the region operations (e.g.,
+ ../include/grid/drogon.multregt for this case).
+
+Norne
+-----
+By downloading the `Norne model `_ (and replacing the needed include files as described in the previous
+example), then here we create a coarser model by removing certain pilars in order to keep the main features of the geological model:
+
+.. code-block:: bash
+
+ pycopm -i NORNE_ATW2013.DATA -x 0,2,0,2,2,0,2,0,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,0,2,0,2,2,0,2,2,0,2,2,2,2,0 -y 0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,2,0,2,0,2,0,2,0,2,0,2,0,2,0,2,0,2,0,2,0,2,2,2,2,2,2,2,2,2,0 -z 0,0,2,0,0,2,2,2,2,2,02,2,2,2,2,0,0,2,0,2,2,0,0,0,0,0,0,0,0,0,0 -a min -p 1
+
+this would generate the following coarse model:
+
+.. figure:: figs/norne_vec.png
diff --git a/docs/text/figs/hello_world_1.png b/docs/text/figs/hello_world_1.png
new file mode 100644
index 0000000..dad7676
Binary files /dev/null and b/docs/text/figs/hello_world_1.png differ
diff --git a/docs/text/figs/hello_world_2.png b/docs/text/figs/hello_world_2.png
new file mode 100644
index 0000000..59f6e0e
Binary files /dev/null and b/docs/text/figs/hello_world_2.png differ
diff --git a/docs/text/figs/norne_vec.png b/docs/text/figs/norne_vec.png
new file mode 100644
index 0000000..96b88bc
Binary files /dev/null and b/docs/text/figs/norne_vec.png differ
diff --git a/docs/text/figs/output_generic.png b/docs/text/figs/output_generic.png
index 37d880a..9f553cb 100644
Binary files a/docs/text/figs/output_generic.png and b/docs/text/figs/output_generic.png differ
diff --git a/docs/text/figs/smeia.png b/docs/text/figs/smeia.png
index cd4845d..5c75516 100644
Binary files a/docs/text/figs/smeia.png and b/docs/text/figs/smeia.png differ
diff --git a/docs/text/introduction.rst b/docs/text/introduction.rst
index b68ab76..3388bdb 100644
--- a/docs/text/introduction.rst
+++ b/docs/text/introduction.rst
@@ -12,8 +12,8 @@ Simplified and flexible framework to create coarser OPM Flow geological models.
Roadmap
-------
-In the initial development of the framework, the focus was two available models in `opm-tests `_: `norne `_
-and `drogon `_, where the coarser models are used to perform history matching studies using
+In the initial development of the framework, the focus were two available models in `opm-tests `_: `norne `_
+and `drogon `_, where the coarser models were used to perform history matching studies using
the Ensemble based reservoir tool `ERT `_) file.
@@ -29,4 +29,10 @@ The following screenshot shows the input deck and generated files in the selecte
.. figure:: figs/output_generic.png
Then, after running **pycopm**, one could adapt the generated files with the coarser geological model in your
-favourite history matching/optimization tool (e.g., `ERT `_).
\ No newline at end of file
+favourite history matching/optimization tool (e.g., `ERT `_).
+
+.. Note::
+ For input decks that include other files without giving the full path (e.g., './include/summary...'), then we recommend
+ to use the default output folder (-o .), i.e., the generated deck and coarse files would be generated in the same location as
+ the input deck and no errors would appear for not finding the include files; otherwise, you might need to copy all needed folders
+ with the include files to the output folder or setting the correct path to the include files in the generated coarse deck.
\ No newline at end of file
diff --git a/src/pycopm/core/pycopm.py b/src/pycopm/core/pycopm.py
index 90ac289..7bf44de 100644
--- a/src/pycopm/core/pycopm.py
+++ b/src/pycopm/core/pycopm.py
@@ -29,6 +29,10 @@ def pycopm():
dic["nhow"] = cmdargs["nhow"].strip() # Max, min, or mode for other nums
dic["show"] = cmdargs["show"].strip() # Max, min, or mean for static props
dic["jump"] = cmdargs["jump"].strip() # Tuning parameter to remove nnc
+ dic["write"] = cmdargs["write"].strip() # Name of the generated deck
+ dic["mode"] = cmdargs["mode"].strip() # What to run
+ dic["label"] = cmdargs["label"].strip() # Prefix to the generted inc files
+ dic["ijk"] = cmdargs["ijk"].strip() # ijk indices to map to the coarse model
dic["encoding"] = cmdargs["encoding"].strip()
dic["pvcorr"] = int(cmdargs["pvcorr"])
dic["cijk"] = "yes"
@@ -122,30 +126,14 @@ def load_parser():
"-f",
"--flow",
default="flow",
- help="OPM Flow path to executable or just 'flow' ('flow' by default)",
+ help="OPM Flow path to executable or just 'flow' ('flow' by default).",
)
parser.add_argument(
"-c",
"--coarsening",
default="2,2,2",
- help="Level of coarsening in the x, y, and z dir ('2,2,2' by default)",
- )
- parser.add_argument(
- "-a",
- "--how",
- default="max",
- help="Use 'min', 'max', or 'mode' to scale the actnum, e.g., min makes "
- "the new coarser cell inactive it at least one cell is inactive, while "
- " max makes it active it at least one cell is active ('max' by default)",
- )
- parser.add_argument(
- "-j",
- "--jump",
- default="",
- help="Tuning parameter to avoid creation of neighbouring connections in "
- "the coarser model where there are discontinuities between cells along "
- "the z direction, e.g., around faults ('' by default, i.e., nothing "
- "corrected; if need it, try with values of the order of 1)",
+ help="Level of coarsening in the x, y, and z dir ('2,2,2' by default; "
+ "either use this flag or the -x, -y, and -z ones).",
)
parser.add_argument(
"-x",
@@ -154,46 +142,95 @@ def load_parser():
help="Vector of x-coarsening, e.g., if the grid has 6 cells in the x "
"direction, then 0,2,0,2,0,2,0 would generate a coarser model with 3 "
"cells, while 0,2,2,2,2,2,0 would generate a coarser model with 1 cell, "
- "i.e., 0 keeps the pilars while 2 removes them ('' by default)",
+ "i.e., 0 keeps the pilars while 2 removes them ('' by default).",
)
parser.add_argument(
"-y",
"--ycoar",
default="",
- help="Vector of y-coarsening, see the description for -x ('' by default)",
+ help="Vector of y-coarsening, see the description for -x ('' by default).",
)
parser.add_argument(
"-z",
"--zcoar",
default="",
- help="Vector of z-coarsening, see the description for -x ('' by default)",
+ help="Vector of z-coarsening, see the description for -x ('' by default).",
)
parser.add_argument(
- "-e",
- "--encoding",
- default="ISO-8859-1",
- help="Use 'utf8' or 'ISO-8859-1' encoding to read the deck ('ISO-8859-1' by default)",
- )
- parser.add_argument(
- "-p",
- "--pvcorr",
- default=0,
- help="Add the removed pore volume to the closest coarser cells ('0' by default)",
+ "-a",
+ "--how",
+ default="mode",
+ help="Use 'min', 'max', or 'mode' to scale the actnum, e.g., min makes "
+ "the new coarser cell inactive if at least one cell is inactive, while "
+ " max makes it active it at least one cell is active ('mode' by default).",
)
parser.add_argument(
"-n",
"--nhow",
default="mode",
- help="Use 'min', 'max', or 'mode' to scale satnum, fipnum, pvtnum, eqlnum, imbnum, and "
- "multnum ('mode' by default)",
+ help="Use 'min', 'max', or 'mode' to scale endnum, eqlnum, fipnum, fluxnum, imbnum, "
+ "miscnum, multnum, pvtnum, rocknum, and satnum ('mode' by default).",
)
parser.add_argument(
"-s",
"--show",
default="",
- help="Use 'min', 'max', or 'mean' to scale permx, permy, permz, and poro ('' by default,"
- " i.e., using the arithmetic average for permx/permy, harmonic average for permz, and "
- "the mean for the porosity).",
+ help="Use 'min', 'max', or 'mean' to scale permx, permy, permz, poro, swatinit, and all "
+ "mult(-)xyz ('' by default, i.e., using the arithmetic average for permx/permy, harmonic"
+ " average for permz, and the mean for the rest).",
+ )
+ parser.add_argument(
+ "-p",
+ "--pvcorr",
+ default=0,
+ help="Add the removed pore volume to the closest coarser cells ('0' by default).",
+ )
+ parser.add_argument(
+ "-j",
+ "--jump",
+ default="",
+ help="Tuning parameter to avoid creation of neighbouring connections in "
+ "the coarser model where there are discontinuities between cells along "
+ "the z direction, e.g., around faults ('' by default, i.e., nothing "
+ "corrected; if need it, try with values of the order of 1).",
+ )
+ parser.add_argument(
+ "-m",
+ "--mode",
+ default="prep_deck",
+ help="Execute a dry run on the input deck to generate the static properties ('prep'), "
+ "generate only the coarse files ('deck'), only exectute a dry run on the generated "
+ "coarse model ('dry'), 'prep_deck', 'deck_dry', or do all ('all') ('prep_deck' by "
+ "default).",
+ )
+ parser.add_argument(
+ "-w",
+ "--write",
+ default="",
+ help="Name of the generated deck ('' by default, i.e., the name of the input deck plus "
+ "_PYCOPM.DATA).",
+ )
+ parser.add_argument(
+ "-l",
+ "--label",
+ default="PYCOPM_",
+ help="Added text before each generated .INC ('PYCOPM_' by default, i.e., the coarse porv "
+ "is saved in PYCOPM_PORV.INC; set to '' to generate PORV.INC, PERMX.INC, etc).",
+ )
+ parser.add_argument(
+ "-e",
+ "--encoding",
+ default="ISO-8859-1",
+ help="Use 'utf8' or 'ISO-8859-1' encoding to read the deck ('ISO-8859-1' by default).",
+ )
+ parser.add_argument(
+ "-ijk",
+ "--ijk",
+ default="",
+ help="Given i,j,k indices in the input model, return the coarse i,j,k corresponding "
+ "positions ('' by default; if not empty, e.g., 1,2,3 then the -mode is set to deck and "
+ "there will not be generation of coarse files, only the i,j,k coarse indices in the "
+ "terminal).",
)
return vars(parser.parse_known_args()[0])
diff --git a/src/pycopm/template_scripts/common/grid.mako b/src/pycopm/template_scripts/common/grid.mako
index 7af126a..8507d8f 100644
--- a/src/pycopm/template_scripts/common/grid.mako
+++ b/src/pycopm/template_scripts/common/grid.mako
@@ -23,15 +23,6 @@ ${f"{dic['zc'][i] : .3f}"}
/
% if dic['field']=='generic':
-INIT
-INCLUDE
-'PORO.INC' /
-INCLUDE
-'PERMX.INC' /
-INCLUDE
-'PERMY.INC' /
-INCLUDE
-'PERMZ.INC' /
ACTNUM
% for i in range(len(dic['actnum_c'])):
${f"{dic['actnum_c'][i]}"}
diff --git a/src/pycopm/utils/generate_coarser_files.py b/src/pycopm/utils/generate_coarser_files.py
index 7136d29..8be07aa 100644
--- a/src/pycopm/utils/generate_coarser_files.py
+++ b/src/pycopm/utils/generate_coarser_files.py
@@ -8,6 +8,7 @@
import os
import csv
+import sys
import numpy as np
from resdata.grid import Grid
from resdata.resfile import ResdataFile
@@ -26,82 +27,162 @@ def create_deck(dic):
dic (dict): Modified global dictionary
"""
- dic["flags"] = "--parsing-strictness=low --enable-dry-run=true"
- os.system(f"{dic['flow']} {dic['deck'].upper()}.DATA {dic['flags']} & wait\n")
-
- # Read the data
- dic["field"] = "generic"
- dic["props"] = ["poro", "permx", "permy", "permz"]
- dic["regions"] = []
- dic["grids"] = []
- dic["grid"] = Grid(f"{dic['exe']}/" + dic["deck"] + ".EGRID")
- dic["ini"] = ResdataFile(f"{dic['exe']}/" + dic["deck"] + ".INIT")
- if dic["ini"].has_kw("SWATINIT"):
- dic["props"] += ["swatinit"]
- if dic["ini"].has_kw("MULTNUM"):
- dic["grids"] += ["multnum"]
- for name in ["satnum", "eqlnum", "fipnum", "pvtnum", "imbnum"]:
- if dic["ini"].has_kw(name.upper()):
- if max(dic["ini"].iget_kw(name.upper())[0]) > 1:
- dic["regions"] += [name]
- nc = dic["grid"].nx * dic["grid"].ny * dic["grid"].nz
- dic["con"] = np.array([0 for _ in range(nc)])
- dic["porv"] = np.array(dic["ini"].iget_kw("PORV")[0])
- actnum = np.array([0 for _ in range(nc)])
- d_z = np.array([np.nan for _ in range(nc)])
- z_t = np.array([np.nan for _ in range(nc)])
- z_b = np.array([np.nan for _ in range(nc)])
- z_b_t = np.array([np.nan for _ in range(nc)])
- for name in dic["props"] + dic["regions"] + dic["grids"]:
- dic[name] = 1.0 * np.ones(nc) * np.nan
- n = 0
- zti = [2, 5, 8, 11]
- zbi = [14, 17, 20, 23]
- cxyz = dic["grid"].export_corners(dic["grid"].export_index())
- for cell in dic["grid"].cells():
- actnum[cell.global_index] = cell.active
- z_t[cell.global_index] = min(cxyz[cell.global_index][i] for i in zti)
- z_b[cell.global_index] = max(cxyz[cell.global_index][i] for i in zti)
- tmp = max(cxyz[cell.global_index][i] for i in zbi)
- z_b_t[cell.global_index] = tmp - z_t[cell.global_index]
- if cell.active == 1:
- d_z[cell.global_index] = dic["grid"].cell_dz(ijk=(cell.i, cell.j, cell.k))
- for name in dic["props"] + dic["regions"] + dic["grids"]:
- dic[name][cell.global_index] = dic["ini"].iget_kw(name.upper())[0][n]
- if not dic["show"]:
- dic["permx"][cell.global_index] = (
- dic["ini"].iget_kw("PERMX")[0][n] * d_z[cell.global_index]
+ if dic["ijk"]:
+ dic["ijk"] = [int(val) for val in dic["ijk"].split(",")]
+ dic["mode"] = "deck"
+ if not dic["write"]:
+ dic["write"] = dic["deck"] + "_PYCOPM"
+ dic["flags"] = "--parsing-strictness=low --enable-dry-run=true --output-mode=none"
+ if dic["mode"] in ["prep", "prep_deck", "all"]:
+ os.system(f"cp {dic['deck']}.DATA {dic['deck']}_PREP_PYCOPM_DRYRUN.DATA")
+ print(
+ f"\nCloning {dic['deck']}.DATA to {dic['deck']}_PREP_PYCOPM_DRYRUN.DATA for"
+ " the intial dry run to generate the grid (.EGRID) and static (.INIT) "
+ "properties\n"
+ )
+ os.system(
+ f"{dic['flow']} {dic['deck']}_PREP_PYCOPM_DRYRUN.DATA {dic['flags']} "
+ f"--output-dir={dic['fol']}"
+ )
+ os.system(f"mv {dic['deck']}_PREP_PYCOPM_DRYRUN.DATA " + f"{dic['fol']}")
+ for name in [".INIT", ".EGRID"]:
+ files = f"{dic['fol']}/{dic['deck']}_PREP_PYCOPM_DRYRUN" + name
+ if not os.path.isfile(files):
+ if name == ".INIT":
+ print(
+ f"\nThe {files} is not found, try adding the keyword INIT in"
+ f" the GRID section in the original deck {dic['deck']}.DATA\n"
+ )
+ else:
+ print(
+ f"\nThe {files} is not found, try removing the keyword GRIDFILE in"
+ f" the GRID section in the original deck {dic['deck']}.DATA\n"
+ )
+ sys.exit()
+ print("\nThe dry run succeeded")
+
+ if dic["mode"] in ["prep_deck", "deck", "deck_dry", "all"]:
+ dic["deck"] = f"{dic['fol']}/{dic['deck']}_PREP_PYCOPM_DRYRUN"
+ for name in [".INIT", ".EGRID"]:
+ files = dic["deck"] + name
+ if not os.path.isfile(files):
+ print(
+ f"\nThe {files} is not found, try running pycopm with -m prep_deck "
+ "and without -ijk"
)
- dic["permy"][cell.global_index] = (
- dic["ini"].iget_kw("PERMY")[0][n] * d_z[cell.global_index]
+ sys.exit()
+ dic["field"] = "generic"
+ dic["props"] = ["poro", "permx", "permy", "permz"]
+ dic["base"] = dic["props"] + ["grid"]
+ dic["regions"] = []
+ dic["grids"] = []
+ dic["mults"] = []
+ dic["special"] = []
+ dic["grid"] = Grid(f"{dic['exe']}/" + dic["deck"] + ".EGRID")
+ dic["ini"] = ResdataFile(f"{dic['exe']}/" + dic["deck"] + ".INIT")
+ if not dic["ijk"]:
+ print("\nInitializing pycopm to generate the coarse files, please wait")
+ if dic["ini"].has_kw("SWATINIT"):
+ dic["props"] += ["swatinit"]
+ dic["special"] += ["swatinit"]
+ for name in ["multx", "multx-", "multy", "multy-", "multz", "multz-"]:
+ if dic["ini"].has_kw(name.upper()):
+ tmp = np.array(dic["ini"].iget_kw(name.upper())[0])
+ if 0 < sum(tmp != 1):
+ dic["props"] += [name]
+ dic["mults"] += [name]
+ for name in ["multnum", "fluxnum"]:
+ if dic["ini"].has_kw(name.upper()):
+ if max(dic["ini"].iget_kw(name.upper())[0]) > 1:
+ dic["grids"] += [name]
+ for name in [
+ "endnum",
+ "eqlnum",
+ "fipnum",
+ "imbnum",
+ "miscnum",
+ "pvtnum",
+ "rocknum",
+ "satnum",
+ ]:
+ if dic["ini"].has_kw(name.upper()):
+ if max(dic["ini"].iget_kw(name.upper())[0]) > 1:
+ dic["regions"] += [name]
+ nc = dic["grid"].nx * dic["grid"].ny * dic["grid"].nz
+ dic["con"] = np.array([0 for _ in range(nc)])
+ dic["porv"] = np.array(dic["ini"].iget_kw("PORV")[0])
+ actnum = np.array([0 for _ in range(nc)])
+ d_z = np.array([np.nan for _ in range(nc)])
+ z_t = np.array([np.nan for _ in range(nc)])
+ z_b = np.array([np.nan for _ in range(nc)])
+ z_b_t = np.array([np.nan for _ in range(nc)])
+ for name in dic["props"] + dic["regions"] + dic["grids"]:
+ dic[name] = 1.0 * np.ones(nc) * np.nan
+ n = 0
+ zti = [2, 5, 8, 11]
+ zbi = [14, 17, 20, 23]
+ cxyz = dic["grid"].export_corners(dic["grid"].export_index())
+ for cell in dic["grid"].cells():
+ actnum[cell.global_index] = cell.active
+ z_t[cell.global_index] = min(cxyz[cell.global_index][i] for i in zti)
+ z_b[cell.global_index] = max(cxyz[cell.global_index][i] for i in zti)
+ tmp = max(cxyz[cell.global_index][i] for i in zbi)
+ z_b_t[cell.global_index] = tmp - z_t[cell.global_index]
+ if cell.active == 1:
+ d_z[cell.global_index] = dic["grid"].cell_dz(
+ ijk=(cell.i, cell.j, cell.k)
)
- if dic["ini"].iget_kw("PERMZ")[0][n] != 0:
- dic["permz"][cell.global_index] = (
- d_z[cell.global_index] / dic["ini"].iget_kw("PERMZ")[0][n]
+ for name in dic["props"] + dic["regions"] + dic["grids"]:
+ dic[name][cell.global_index] = dic["ini"].iget_kw(name.upper())[0][
+ n
+ ]
+ if not dic["show"]:
+ dic["permx"][cell.global_index] = (
+ dic["ini"].iget_kw("PERMX")[0][n] * d_z[cell.global_index]
)
- n += 1
+ dic["permy"][cell.global_index] = (
+ dic["ini"].iget_kw("PERMY")[0][n] * d_z[cell.global_index]
+ )
+ if dic["ini"].iget_kw("PERMZ")[0][n] != 0:
+ dic["permz"][cell.global_index] = (
+ d_z[cell.global_index] / dic["ini"].iget_kw("PERMZ")[0][n]
+ )
+ n += 1
- # Coarsening
- handle_clusters(dic)
- map_ijk(dic)
- clusmin, clusmax, rmv = map_properties(dic, actnum, d_z, z_t, z_b, z_b_t)
- if dic["pvcorr"] == 1:
- handle_pv(dic, clusmin, clusmax, rmv)
- handle_cp_grid(dic)
- write_grid(dic)
- write_props(dic)
- process_the_deck(dic)
- with open(
- f"{dic['exe']}/{dic['fol']}/{dic['deck'].upper()}_PYCOPM.DATA",
- "w",
- encoding="utf8",
- ) as file:
- for row in dic["lol"]:
- file.write(row + "\n")
- # os.chdir(dic["fol"])
- # os.system(
- # f"{dic['flow']} {dic['deck'].upper()}_PYCOPM.DATA --enable-dry-run=1 & wait\n"
- # )
+ # Coarsening
+ handle_clusters(dic)
+ map_ijk(dic)
+ if dic["ijk"]:
+ print(
+ dic["ic"][dic["ijk"][0]],
+ dic["jc"][dic["ijk"][1]],
+ dic["kc"][dic["ijk"][2]],
+ )
+ sys.exit()
+ clusmin, clusmax, rmv = map_properties(dic, actnum, d_z, z_t, z_b, z_b_t)
+ if dic["pvcorr"] == 1:
+ handle_pv(dic, clusmin, clusmax, rmv)
+ handle_cp_grid(dic)
+ write_grid(dic)
+ write_props(dic)
+ process_the_deck(dic)
+ with open(
+ f"{dic['exe']}/{dic['fol']}/{dic['write']}.DATA",
+ "w",
+ encoding="utf8",
+ ) as file:
+ for row in dic["lol"]:
+ file.write(row + "\n")
+ print(
+ f"\nThe generation of coarse files succeeded, see {dic['fol']}/"
+ f"{dic['write']}.DATA and {dic['fol']}/{dic['label']}*.INC"
+ )
+
+ if dic["mode"] in ["deck_dry", "dry", "all"]:
+ print("\nCall OPM Flow for a dry run of the coarse model\n")
+ os.chdir(dic["fol"])
+ os.system(f"{dic['flow']} {dic['write']}.DATA {dic['flags']}")
+ print("\nThe dry run of the coarse model succeeded\n")
def map_properties(dic, actnum, d_z, z_t, z_b, z_b_t):
@@ -121,7 +202,7 @@ def map_properties(dic, actnum, d_z, z_t, z_b, z_b_t):
"""
clusmax = pd.Series(actnum).groupby(dic["con"]).max()
freq = pd.Series(actnum).groupby(dic["con"]).sum()
- dz_c = pd.Series(z_b_t).groupby(dic["con"]).max()
+ dz_c = pd.Series(z_b_t).groupby(dic["con"]).mean()
h_tot = pd.Series(d_z).groupby(dic["con"]).sum()
if dic["how"] == "min":
clusmin = pd.Series(actnum).groupby(dic["con"]).min()
@@ -184,21 +265,23 @@ def map_properties(dic, actnum, d_z, z_t, z_b, z_b_t):
for name in dic["regions"] + dic["grids"]:
if dic["nhow"] == "min":
c_c = pd.Series(dic[name]).groupby(dic["con"]).min()
+ dic[f"{name}_c"] = [
+ f"{int(val)}" if not np.isnan(val) else "0" for val in c_c
+ ]
elif dic["nhow"] == "max":
c_c = pd.Series(dic[name]).groupby(dic["con"]).max()
+ dic[f"{name}_c"] = [
+ f"{int(val)}" if not np.isnan(val) else "0" for val in c_c
+ ]
else:
c_c = (
pd.Series(dic[name])
.groupby(dic["con"])
- .agg(
- lambda x: (
- pd.Series.mode(x).iat[0]
- if len(pd.Series.mode(x)) > 1
- else pd.Series.mode(x)
- )
- )
+ .agg(lambda x: list(pd.Series.mode(x)))
)
- dic[f"{name}_c"] = [f"{int(val)}" if np.isscalar(val) else "0" for val in c_c]
+ dic[f"{name}_c"] = [
+ f"{int(val[0])}" if len(val) > 0 else "0" for val in c_c
+ ]
return clusmin, clusmax, rmv
@@ -321,17 +404,7 @@ def write_grid(dic):
dic["files"] = [f for f in os.listdir(f"{dic['exe']}") if f.endswith(".INC")]
for file in dic["files"]:
copy = True
- for prop in [
- "PORO",
- "PERM",
- "TOPS",
- "PHI",
- "FIPNUM",
- "SATNUM",
- "NTG",
- "GRID",
- "PORV",
- ]:
+ for prop in dic["props"] + dic["regions"] + dic["grids"] + ["porv"]:
if prop in file:
copy = False
if copy:
@@ -339,7 +412,9 @@ def write_grid(dic):
var = {"dic": dic}
mytemplate = Template(filename=f"{dic['pat']}/template_scripts/common/grid.mako")
filledtemplate = mytemplate.render(**var)
- with open(f"{dic['exe']}/{dic['fol']}/GRID.INC", "w", encoding="utf8") as f:
+ with open(
+ f"{dic['exe']}/{dic['fol']}/{dic['label']}GRID.INC", "w", encoding="utf8"
+ ) as f:
f.write(filledtemplate)
@@ -362,7 +437,7 @@ def write_props(dic):
)
dic[f"{name}_c"].append("/")
with open(
- f"{dic['exe']}/{dic['fol']}/{name.upper()}.INC",
+ f"{dic['exe']}/{dic['fol']}/{dic['label']}{name.upper()}.INC",
"w",
encoding="utf8",
) as file:
@@ -547,6 +622,8 @@ def process_the_deck(dic):
dic["compdat"] = False
dic["compsegs"] = False
dic["mapaxes"] = False
+ dic["props"] = False
+ dic["oper"] = False
dic["region"] = False
dic["fault"] = False
with open(dic["deck"] + ".DATA", "r", encoding=dic["encoding"]) as file:
@@ -563,15 +640,88 @@ def process_the_deck(dic):
continue
if handle_grid_props(dic, nrwo):
continue
+ if handle_props(dic, nrwo):
+ continue
if handle_regions(dic, nrwo):
continue
if handle_wells(dic, nrwo):
continue
if handle_segmented_wells(dic, nrwo):
continue
+ for case in dic["special"]:
+ if (
+ case + "." in nrwo.lower()
+ or "." + case in nrwo.lower()
+ or "swinitial." in nrwo.lower()
+ ):
+ nrwo = f"{dic['label']}{case.upper()}.INC/"
dic["lol"].append(nrwo)
+def handle_props(dic, nrwo):
+ """
+ Handle the props sections
+
+ Args:
+ dic (dict): Global dictionary\n
+ nrwo (list): Splited row from the input deck
+
+ Returns:
+ dic (dict): Modified global dictionary
+
+ """
+ if nrwo == "PROPS" and not dic["props"]:
+ dic["props"] = True
+ dic["lol"].append(nrwo + "\n")
+ return True
+ if dic["props"]:
+ if handle_oper(dic, nrwo):
+ return True
+ if nrwo in ["REGIONS", "SOLUTION"]:
+ dic["props"] = False
+ return False
+
+
+def handle_oper(dic, nrwo):
+ """
+ We also support operations
+
+ Args:
+ dic (dict): Global dictionary\n
+ nrwo (list): Splited row from the input deck
+
+ Returns:
+ dic (dict): Modified global dictionary
+
+ """
+ if nrwo in ["EQUALS", "COPY", "ADD", "MULTIPLY"]:
+ if not dic["props"] and nrwo == "COPY":
+ return False
+ dic["oper"] = True
+ dic["lol"].append(nrwo)
+ return True
+ if dic["oper"]:
+ edit = nrwo.split()
+ if edit:
+ if edit[0] == "/":
+ dic["oper"] = False
+ if len(edit) > 7:
+ if edit[0][:2] != "--":
+ if "PERM" in edit[0]:
+ edit[1] = "1"
+ edit[2] = str(dic["ic"][int(edit[2])])
+ edit[3] = str(dic["ic"][int(edit[3])])
+ edit[4] = str(dic["jc"][int(edit[4])])
+ edit[5] = str(dic["jc"][int(edit[5])])
+ edit[6] = str(dic["kc"][int(edit[6])])
+ edit[7] = str(dic["kc"][int(edit[7])])
+ dic["lol"].append(" ".join(edit))
+ return True
+ if not dic["props"]:
+ dic["lol"].append(nrwo)
+ return False
+
+
def handle_regions(dic, nrwo):
"""
Handle the regions sections
@@ -593,7 +743,7 @@ def handle_regions(dic, nrwo):
dic["region"] = False
for name in dic["regions"]:
dic["lol"].append("INCLUDE")
- dic["lol"].append(f"'{name.upper()}.INC' /\n")
+ dic["lol"].append(f"'{dic['label']}{name.upper()}.INC' /\n")
else:
return True
return False
@@ -614,22 +764,23 @@ def handle_grid_props(dic, nrwo):
if nrwo == "GRID" and not dic["removeg"]:
dic["removeg"] = True
dic["lol"].append(nrwo + "\n")
- dic["lol"].append("INCLUDE")
- dic["lol"].append("'GRID.INC' /\n")
- for name in dic["grids"]:
+ dic["lol"].append("INIT")
+ for name in dic["base"] + dic["grids"] + dic["mults"]:
dic["lol"].append("INCLUDE")
- dic["lol"].append(f"'{name.upper()}.INC' /\n")
+ dic["lol"].append(f"'{dic['label']}{name.upper()}.INC' /\n")
return True
if dic["removeg"]:
if handle_fault(dic, nrwo):
return True
if handle_mapaxes(dic, nrwo):
return True
+ # if handle_oper(dic, nrwo):
+ # return True
if nrwo == "PROPS":
dic["removeg"] = False
dic["lol"].append("EDIT\n")
dic["lol"].append("INCLUDE")
- dic["lol"].append("'PORV.INC' /\n")
+ dic["lol"].append(f"'{dic['label']}PORV.INC' /\n")
else:
return True
return False
@@ -647,9 +798,12 @@ def handle_mapaxes(dic, nrwo):
dic (dict): Modified global dictionary
"""
- if nrwo == "MAPAXES":
+ if "MAPAXES" in nrwo:
+ edit = nrwo.split()
+ if edit[0] != "MAPAXES":
+ return False
dic["mapaxes"] = True
- dic["lol"].append(nrwo)
+ dic["lol"].append(edit[0])
return True
if dic["mapaxes"]:
edit = nrwo.split()
diff --git a/tests/decks/HELLO_WORLD.DATA b/tests/decks/HELLO_WORLD.DATA
new file mode 100644
index 0000000..c9547dd
--- /dev/null
+++ b/tests/decks/HELLO_WORLD.DATA
@@ -0,0 +1,168 @@
+-- This reservoir simulation deck is made available under the Open Database
+-- License: http://opendatacommons.org/licenses/odbl/1.0/. Any rights in
+-- individual contents of the database are licensed under the Database Contents
+-- License: http://opendatacommons.org/licenses/dbcl/1.0/
+
+-- Copyright (C) 2024 NORCE
+---------------------------------------------------------------------------
+RUNSPEC
+---------------------------------------------------------------------------
+DIMENS
+20 1 20 /
+
+EQLDIMS
+/
+
+TABDIMS
+/
+
+GAS
+WATER
+CO2STORE
+
+METRIC
+
+START
+18 'JAN' 1991 /
+
+UNIFOUT
+---------------------------------------------------------------------------
+GRID
+---------------------------------------------------------------------------
+INIT
+
+DX
+400*1 /
+
+DY
+400*1 /
+
+DZ
+400*1 /
+
+TOPS
+20*0 /
+
+PORO
+20*0.01
+20*0.02
+20*0.03
+20*0.04
+20*0.05
+20*0.06
+20*0.07
+20*0.08
+20*0.09
+20*0.10
+20*0.11
+20*0.12
+20*0.13
+20*0.14
+20*0.15
+20*0.16
+20*0.17
+20*0.18
+20*0.19
+20*0.20
+/
+
+PERMX
+20*100
+20*200
+20*300
+20*400
+20*500
+20*600
+20*700
+20*800
+20*900
+20*1000
+20*1100
+20*1200
+20*1300
+20*1400
+20*1500
+20*1600
+20*1700
+20*1800
+20*1900
+20*2000
+/
+
+PERMY
+400*1/
+
+PERMZ
+20*100
+20*200
+20*300
+20*400
+20*500
+20*600
+20*700
+20*800
+20*900
+20*1000
+20*1100
+20*1200
+20*1300
+20*1400
+20*1500
+20*1600
+20*1700
+20*1800
+20*1900
+20*2000
+/
+
+EQUALS
+PORO 0 6 10 1* 1* 6 10 /
+PORO 0.08 8 8 1* 1* 8 8 /
+/
+---------------------------------------------------------------------------
+PROPS
+---------------------------------------------------------------------------
+SGWFN
+0 0 1 0
+1 1 0 0 /
+---------------------------------------------------------------------------
+REGIONS
+---------------------------------------------------------------------------
+FIPNUM
+20*1
+20*2
+20*3
+20*4
+20*5
+20*6
+20*7
+20*8
+20*9
+20*10
+20*11
+20*12
+20*13
+20*14
+20*15
+20*16
+20*17
+20*18
+20*19
+20*20
+/
+---------------------------------------------------------------------------
+SOLUTION
+---------------------------------------------------------------------------
+EQUIL
+0 1 0 0 0 0 1 1 0 /
+
+RPTRST
+BASIC=2 /
+---------------------------------------------------------------------------
+SCHEDULE
+---------------------------------------------------------------------------
+RPTRST
+BASIC=2 /
+
+TSTEP
+1 /
\ No newline at end of file
diff --git a/tests/test_generic_deck.py b/tests/test_generic_deck.py
index af4d468..47acde4 100644
--- a/tests/test_generic_deck.py
+++ b/tests/test_generic_deck.py
@@ -10,35 +10,74 @@
def test_generic_deck():
"""pycopm application to coarser a geological model given an input deck"""
cwd = os.getcwd()
- os.chdir(f"{cwd}/tests")
- os.system("mkdir generic_deck")
- os.chdir(f"{cwd}/tests/generic_deck")
- for name in ["PERM", "PHI", "TOPS"]:
- subprocess.run(
- [
- "curl",
- "-o",
- f"./SPE10MODEL2_{name}.INC",
- "https://raw.githubusercontent.com/OPM/opm-data/master/spe10model2/"
- + f"SPE10MODEL2_{name}.INC",
- ],
- check=True,
- )
+ os.chdir(f"{os.getcwd()}/tests/decks")
subprocess.run(
[
- "curl",
+ "pycopm",
+ "-i",
+ "HELLO_WORLD.DATA",
"-o",
- "./SPE10_MODEL2.DATA",
- "https://raw.githubusercontent.com/OPM/opm-data/master/spe10model2/"
- + "SPE10_MODEL2.DATA",
+ "coarser",
+ "-c",
+ "5,1,5",
+ "-m",
+ "prep",
],
check=True,
)
+ assert os.path.exists(
+ f"{cwd}/tests/decks/coarser/HELLO_WORLD_PREP_PYCOPM_DRYRUN.INIT"
+ )
+ assert os.path.exists(
+ f"{cwd}/tests/decks/coarser/HELLO_WORLD_PREP_PYCOPM_DRYRUN.EGRID"
+ )
+ for ahow in ["max", "min", "mode"]:
+ for nhow in ["max", "min", "mode"]:
+ for show in ["max", "min", "mean"]:
+ subprocess.run(
+ [
+ "pycopm",
+ "-i",
+ "HELLO_WORLD.DATA",
+ "-o",
+ "coarser",
+ "-c",
+ "5,1,5",
+ "-m",
+ "deck",
+ "-a",
+ ahow,
+ "-n",
+ nhow,
+ "-s",
+ show,
+ ],
+ check=True,
+ )
+ assert os.path.exists(
+ f"{cwd}/tests/decks/coarser/HELLO_WORLD_PYCOPM.DATA"
+ )
+ os.system(f"rm {cwd}/tests/decks/coarser/HELLO_WORLD_PYCOPM.DATA")
subprocess.run(
- ["pycopm", "-i", "SPE10_MODEL2.DATA", "-o", "coarser", "-c", "4,8,2"],
+ [
+ "pycopm",
+ "-i",
+ "HELLO_WORLD.DATA",
+ "-o",
+ "coarser",
+ "-m",
+ "deck_dry",
+ "p",
+ "1",
+ "-n",
+ "mode",
+ "-x",
+ "0,0,0,0,0,2,2,2,2,2,0,0,0,0,0,0,0,0,0,0,0",
+ "-z",
+ "0,0,0,0,0,0,0,0,0,0,0,0,0,2,2,2,2,2,0,0,0",
+ ],
check=True,
)
- os.chdir(f"{cwd}/tests/generic_deck/coarser")
- os.system("flow SPE10_MODEL2_PYCOPM.DATA --parsing-strictness=low & wait\n")
- assert os.path.exists(f"{cwd}/tests/generic_deck/coarser/SPE10_MODEL2_PYCOPM.UNRST")
+ assert os.path.exists(f"{cwd}/tests/decks/coarser/HELLO_WORLD_PYCOPM.INIT")
+ assert os.path.exists(f"{cwd}/tests/decks/coarser/HELLO_WORLD_PYCOPM.EGRID")
os.chdir(cwd)