Merge pull request #4297 from blattms/feature/update-manpages-2024.10

Update manpages for release
OPM · Nov 5, 2024 · c82b527 · c82b527
2 parents ab0b302 + a8a80ad
commit c82b527
Show file tree

Hide file tree

Showing 10 changed files with 92 additions and 43 deletions.
diff --git a/docs/man1/arraylist.1 b/docs/man1/arraylist.1
@@ -1,4 +1,4 @@
-.TH SUMMARY "1" "October 2023" "arraylist 2023.10" "User Commands"
+.TH SUMMARY "1" "October 2024" "arraylist 2024.10" "User Commands"
 .SH NAME
 arraylist \- Printer for list of arrays in Eclipse summary files
 .SH SYNOPSIS

diff --git a/docs/man1/co2brinepvt.1 b/docs/man1/co2brinepvt.1
@@ -1,33 +1,69 @@
-.TH CO2BRINEPVT "1" "October 2023" "co2brinepvt" "User Commands"
+.TH CO2BRINEPVT "1" "October 2024" "co2brinepvt" "User Commands"
 .SH NAME
 co2brinepvt \- compute and print pvt properties for co2 with brine
 .SH SYNOPSIS
 .B co2brinepvt
 [\fI\,OPTIONS\/\fR] \fI\,PROPERTY\/\fR \fI\,PHASE\/\fR
-\fI\,PRESSURE\/\fR \fI\,TEMPERATURE\/\fR [\fI\,SALINITY\/\fR]  [\fI\,RS\/\fR]
+\fI\,PRESSURE\/\fR \fI\,TEMPERATURE\/\fR [\fI\,SALINITY\/\fR]
+[\fI\,RS\/\fR] [\fI\,RV\/\fR] [\fI\,SALTMODEL\/\fR]
+[\fI\,THERMAL_MIXING_MODEL_GAS\/\fR]
+[\fI\,THERMAL_MIXING_MODEL_LIQUID\/\fR] [\fI\,THERMAL_MIXING_MODEL_SALT\/\fR]
 .SH DESCRIPTION
-co2brinepvt computes PVT properties of a brine/co2 system
-for a given phase (oil or brine), pressure, temperature, salinity and rs.
-The properties support are: density, the inverse phase formation volume factor (invB), viscosity,
-saturated dissolution factor (rsSat)
+co2brinepvt computes PVT PROPERTY of a brine/co2 system. The
+computation is performed for a given PHASE (oil or brine), PRESSURE
+(in bar), TEMPERATURE (in Celsius),  SALINITY (salt molality in
+mol/kg) and RS (amount of dissolved CO2 in Brine in SM3/SM3), RV
+(amount of vaporized water in Gas in SM3/SM3), salt model
+(SALTMODEL), model of thermal mixing of gas, liquid, amd salt
+(THERMAL_MIXING_MODEL_GAS ans THERMAL_MIXING_MODEL_LIQUID, 
+respectively).
+.PP
 See CO2STORE in the OPM manual for more details.
 .PP
-.SH Synopsis
-co2brinepvt <prop> <phase> <p> <T> <salinity> <rs>
-.br
-where
-.br
-prop = {density, invB, B, viscosity, rsSat, diffusionCoefficient}
-.br
-phase = {CO2, brine}
-.br
-p: pressure in pascal
-.br
-T: temperature in kelvin
-.br
-salinity(optional): salt molality in mol/kg
-.nr
-rs(optional): amount of dissolved CO2 in Brine in SM3/SM3
+PROPERTY, the property computed, may be one of
+.RS
+.nf
+- density (the density)
+- invB (the inverse phase formation volume factor
+- viscosity
+- rSat (saturated dissolution factor)
+- internalEnergy (internal Energy)
+- enthalpy
+- diffusionCoefficient (the diffusion coefficient)
+.RE
+.PP
+SALTMODEL, the model to use for salt, may be one of
+.RS
+.nf
+- 0 = no salt activity
+- 1 = Rumpf et al (1996) [default]
+- 2 = Duan-Sun in Spycher & Pruess (2009)
+- 3 = Duan-Sun in Sycher & Pruess (2005)
+.RE
+.PP
+THERMAL_MIXING_MODEL_GAS, the model of thermal mixing for gas, may be
+one of
+.RS
+.nf
+- 0 = pure component [default]
+- 1 = ideal mixing
+.RE
+.PP
+THERMAL_MIXING_MODEL_LIQUID, the model of thermal mixing for liquid, may be
+one of
+.RS
+.nf
+- 0 = pure component
+- 1 = ideal mixing
+- 2 = heat of dissolution according to duan sun [default]
+.RE
+.PP
+THERMAL_MIXING_MODEL_SALT, the model of thermal mixing for salt, may be
+one of
+.RS
+.nf
+- 0 = pure water
+- 1 = model in MICHAELIDES [default]
 .PP
 .SH OPTIONS
 \fB\-\-h\fR/\-\-help Print help and exit.
diff --git a/docs/man1/compareECL.1 b/docs/man1/compareECL.1
@@ -1,17 +1,19 @@
-.TH COMPAREECL "1" "October 2023" "compareECL 2023.10" "User Commands"
+.TH COMPAREECL "1" "October 2024" "compareECL" "User Commands"
 .SH NAME
 compareECL \- Comparator for Eclipse files
 .SH SYNOPSIS
 .B convertECL
-[\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME_1\/\fR \fI\,ECL_DECK_FILENAME_2\/\fR
+[\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME_1\/\fR
+\fI\,ECL_DECK_FILENAME_2\/\fR \fI\,ABSOLUTE_TOLERANCE\/\fR  \fI\,RELATIVE_TOLERANCE\/\fR
 .SH DESCRIPTION
 compareECL compares ECLIPSE files (restart (.RST), unified restart (.UNRST), initial (.INIT), summary (.SMRY), unified summary (.UNSMRY) or .RFT) and gridsizes (from .EGRID or .GRID file) from two simulations.
 The program takes four arguments:
 .PP
-1. Case number 1, reference case (full path without extension)
-2. Case number 2, test case (full path without extension)
-3. Absolute tolerance
-4. Relative tolerance (between 0 and 1)
+.nf
+- ECL_DECK_FILENAME_1, path to first reference case, but without extension.
+- ECL_DECK_FILENAME_2, path to second reference case, but without extension.
+- ABSOLUTE_TOLERANCE, the absolute tolerance to use for coparison
+- RELATIVE_TOLERANCE, the relative tolerance (between 0 and 1) to use for comparison
 .PP
 .SH OPTIONS
 .HP
@@ -63,8 +65,12 @@ Compare RSM file against a summary file.
 .PP
 .SH Example usage of the program:
 .PP
-compareECL \fB\-k\fR PRESSURE <path to first casefile> <path to second casefile> 1e\-3 1e\-5
-compareECL \fB\-t\fR INIT \fB\-k\fR PORO <path to first casefile> <path to second casefile> 1e\-3 1e\-5
+compareECL \fB\-k\fR PRESSURE <path to first casefile> <path to second
+casefile> 1e\-3 1e\-5
+.PP
+compareECL \fB\-t\fR INIT \fB\-k\fR PORO <path to first casefile>
+<path to second casefile> 1e\-3 1e\-5
+.PP
 compareECL \fB\-i\fR <path to first casefile> <path to second casefile> 0.01 1e\-6
 .PP
 Exceptions are thrown (and hence program exits) when deviations are larger than the specified tolerances, or when the number of cells does not match \fB\-\-\fR either in the grid file or for a specific keyword. Information about the keyword, keyword occurrence (zero based) and cell coordinate is printed when an exception is thrown. For more information about how the cases are compared, see the documentation of the EclFilesComparator class.

diff --git a/docs/man1/convertECL.1 b/docs/man1/convertECL.1
@@ -1,4 +1,4 @@
-.TH CONVERTECL "1" "October 2023" "convertECL 2023.10" "User Commands"
+.TH CONVERTECL "1" "October 2024" "convertECL" "User Commands"
 .SH NAME
 convertECL \- Converter for Eclipse files (binary <-> formatted
 format)
@@ -16,6 +16,10 @@ In addition, the program takes these options (which must be given before the arg
 .TP
 \fB\-l\fR list report step numbers in the selected restart file.
 .TP
+\fB-g\fR Convert file to grdecl format.
+.TP
+\fB-o\fR \fI\,OUTPUT_FILENAME\/\fR Specify output file name (only valid with grdecl option).
+.TP
 \fB\-i\fR Enforce IX standard on output file.
 .TP
 \fB\-r\fR extract and convert a specific report time step number from a unified restart file.

diff --git a/docs/man1/opmhash.1 b/docs/man1/opmhash.1
@@ -1,10 +1,10 @@
-.TH OPMHASH "1" "October 2023" "opmhash 2023.10" "User Commands"
+.TH OPMHASH "1" "October 2024" "opmhash" "User Commands"
 .SH NAME
 opmhash \- Hasher for summary keywords in Eclipse files
 .SH SYNOPSIS
 .B opmhash
 [\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME\/\fR
-[\fI\,ECL_DECK_FILENAME_2\/\fR] [\fI\,ECL_DECK_FILENAME_3\/\fR] ...
+[\fI\,ECL_DECK_FILENAME_2\/\fR] [\fI\,ECL_DECK_FILENAME_3\/\fR] [...]
 .SH DESCRIPTION
 The purpose of the opmhash program is to load a deck and create a summary, by
 diffing two such summaries it is simple to determine if two decks are similar.

diff --git a/docs/man1/opmpack.1 b/docs/man1/opmpack.1
@@ -1,4 +1,4 @@
-.TH OPMPACK "1" "October 2023" "opmpack 2023.10" "User Commands"
+.TH OPMPACK "1" "October 2024" "opmpack" "User Commands"
 .SH NAME
 opmpack \- Validator and printer of deck in Eclipse files without comments
 .SH SYNOPSIS
@@ -9,6 +9,7 @@ The opmpack program will load a deck, resolve all include
 files and then print it out again on stdout. All comments
 will be stripped and the value types will be validated.
 .PP
+.SH OPTIONS
 By passing the option \fB\-o\fR you can redirect the output to a file
 or a directory.
 .PP

diff --git a/docs/man1/rst_deck.1 b/docs/man1/rst_deck.1
@@ -1,10 +1,10 @@
-.TH RST_DECK: "1" "October 2023" "rst_deck 2023.10" "User Commands"
+.TH RST_DECK: "1" "October 2024" "rst_deck" "User Commands"
 .SH NAME
 rst_deck \- Convert simulation deck to a deck ready for restart
 .SH SYNOPSIS
 .B rst_deck
 [\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME\/\fR
-\fI\,RESTART_SOURCE\/\fR [\fI\,BASENAME_RESTART_DECK\/\fR
+\fI\,RESTART_SOURCE\/\fR [\fI\,BASENAME_RESTART_DECK\/\fR]
 .SH DESCRIPTION
 The rst_deck program will load a simulation deck and parameters for a restart
 and reformat the deck to become a restart deck. Before the updated deck is
@@ -83,7 +83,7 @@ negotiated based on the path given to the output case in the third argument.
 If the restart deck is passed to stdout the include files will be resolved
 based on output in cwd.
 .PP
-Example:
+.SH EXAMPLE
 .IP
 rst_deck \fI\,/path/to/history/HISTORY.DATA\/\fP rst/HISTORY:30 \fI\,/path/to/rst/RESTART\/\fP \fB\-s\fR
 .PP

diff --git a/docs/man1/summary.1 b/docs/man1/summary.1
@@ -1,12 +1,14 @@
-.TH SUMMARY "1" "October 2023" "summary 2023.10" "User Commands"
+.TH SUMMARY "1" "October 2024" "summary" "User Commands"
 .SH NAME
 summary \- Printer for summary keys in Eclipse summary files
 .SH SYNOPSIS
 .B summary
 [\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME\/\fR
 \fI\,SUMMARY_KEY1\/\fR [\fI\,SUMMARY_KEY2\/\fR] ...
 .SH DESCRIPTION
-summary needs a minimum of two arguments. First is smspec filename and then list of vectors
+summary needs a minimum of two arguments. First is smspec filename and
+then list of vectors to print.
+.SH OPTIONS
 .PP
 In addition, the program takes these options (which must be given before the arguments):
 .PP

diff --git a/examples/co2brinepvt.cpp b/examples/co2brinepvt.cpp
@@ -131,7 +131,7 @@ int main(int argc, char **argv)
         std::cout << "T: temperature in celcius" << std::endl;
         std::cout << "salinity(optional): salt molality in mol/kg" << std::endl;
         std::cout << "rs(optional): amount of dissolved CO2 in Brine in SM3/SM3" << std::endl;
-        std::cout << "rv(optional): amount of vapporized water in Gas in SM3/SM3" << std::endl;
+        std::cout << "rv(optional): amount of vaporized water in Gas in SM3/SM3" << std::endl;
         std::cout << "saltmodel(optional): 0 = no salt activity; 1 = Rumpf et al (1996) [default];"
                      " 2 = Duan-Sun in Spycher & Pruess (2009); 3 = Duan-Sun in Sycher & Pruess (2005)" << std::endl;
         std::cout << "thermalmixingmodelgas(optional): 0 = pure component [default]; 1 = ideal mixing;" << std::endl;

diff --git a/test_util/compareECL.cpp b/test_util/compareECL.cpp
@@ -30,8 +30,8 @@
 static void printHelp() {
     std::cout << "\ncompareECL compares ECLIPSE files (restart (.RST), unified restart (.UNRST), initial (.INIT), summary (.SMRY), unified summary (.UNSMRY) or .RFT) and gridsizes (from .EGRID or .GRID file) from two simulations.\n"
               << "The program takes four arguments:\n\n"
-              << "1. Case number 1, reference case (full path without extension)\n"
-              << "2. Case number 2, test case (full path without extension)\n"
+              << "1. Case number 1, reference case (path without extension)\n"
+              << "2. Case number 2, test case (path without extension)\n"
               << "3. Absolute tolerance\n"
               << "4. Relative tolerance (between 0 and 1)\n\n"
               << "In addition, the program takes these options (which must be given before the arguments):\n\n"