OilfieldToolsNet/opm-common
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
60437b94df
opm-common/opm/output/eclipse/Tables.hpp

135 lines
5.2 KiB
C++
Raw Normal View History

Framework for adding tables to INIT file - PVTO.
2016-11-16 09:12:59 -06:00
/*
Tables: Add Structurally Correct Water PVT Output This commit adds a new public member function Tables::addPVTTables(const EclipseState&) that calls into a new private member function Tables::addWaterPVTTables(const EclipseState&) to create structurally correct TAB vector entries from the PVTW input table data when water is an active phase in a simulation run. Specifically, the result array has the columns [ Pw, 1/Bw, Cw, 1/(Bw * mu_w), Cw - Cv ] in which 'Cw' denotes the water compressibility and 'Cv' denotes the water viscosibility. Column 4 and 5 follow ECLIPSE 100 conventions. Number of table rows equal to number of PVT regions. This result array differs from the existing Tables::addPVTW() member function in the treatment of viscosity and viscosibility data. We have verified the results with ECLIPSE 100. At present the function is not called by Flow's INIT file writer. Add a unit test to exercise the new member function.
2019-03-28 09:46:41 -05:00
Copyright 2019 Equinor.
Copyright 2017 Statoil ASA.
Framework for adding tables to INIT file - PVTO.
2016-11-16 09:12:59 -06:00
Copyright 2016 Statoil ASA.
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OUTPUT_TABLES_HPP
#define OUTPUT_TABLES_HPP
#include <vector>
Filesystem rename parser/eclipse/ input/eclipse
2021-12-14 01:06:42 -06:00
#include <opm/input/eclipse/EclipseState/Tables/FlatTable.hpp>
Framework for adding tables to INIT file - PVTO.
2016-11-16 09:12:59 -06:00
namespace Opm {
class UnitSystem;
INIT File: Add Support for Writing Saturation Function Tables This commit extends the INIT file Table writing to also output the saturation function tables in normalised form. We support generating the INIT file's SGFN, SOFN, and SWFN tables--including the derivative information--for both two and three phases from both families of saturation function keywords (S{G,W}OF and S{G,W}FN + SOF{2,3}). We do not yet support generating the appropriate tables from input keyword SLGOF. We leverage the LinearisedOutputTable to abstract away some of the details of indexing into the linear 'tab' array and create a helper function to loop across saturation function regions whence each table generator need only be concerned about the specific data pertaining to that region's saturation function (i.e., the values of independent and dependent variates and number of active rows). We allocate the output tables according to information in the TABDIMS keyword, notably the number of saturation nodes (item 3 of TABDIMS). Generating the three-phase SOFN table, which has the same columns as the input table SOF3, in the case of family One (SGOF and SWOF) is slightly involved. In particular we need to join the SGOF and SWOF tables on common oil saturation values and derive/insert missing KroX data through piecewise linear interpolation in the appropriate input table. We defer the details of merging on common (and uniqe) oil saturation values to the standard library routine 'set_union()' which outputs repeated saturation values exactly once rather than for each occurrence. That way we only need to wrap the input tables in a simple class to facilitate look-up of oil saturation values and the mechanics of piecewise linear interpolation of the relative permeability column for oil. Due to this merging process, the number of rows in SOFN is twice the number of saturation nodes in this case. Since this support depends on being able to determine which phases are active in a particular run, what table sizes to use for the output and which keywords are being used to represent the saturation function tables we introduce a single new public member function void Tables::addSatFunc(const EclipseState& es) This function determines the run's active phases and dispatches to the new helper functions void Tables::addSatFunc_FamilyOne() void Tables::addSatFunc_FamilyTwo() according to which keyword family exists in the input deck. These functions in turn call additional helper functions to handle each phase table separately. For instance addSatFunc_FamilyOne() uses the helper function SatFunc::Oil::ThreePhase::fromSGOFandSWOF() to generate a three-phase SOFN table based on the information in the SGOF and SWOF tables. Information about slopes/derivatives for the piecewise interpolants of the dependent variates is computed through the helper function DifferentiateOutputTable::calcSlopes() whence the first entry of each derivative column is undefined (i.e., assigned the sentinel value 1e+20). This should arguably be zero instead. Further testing and comparison with INIT result sets generated by ECL will inform the decision here. We add unit tests for all combinations of number of active phases (two or three) and which saturation function keyword family is present in the simulation case. The unit tests use the tables from SPE 9 for keyword family One and the tables from SPE 1 for keyword family Two. Comparison data is extracted directly from the ECL INIT file in the case of the SPE 9 tables and derived from independent calculation for the SPE 1 tables.
2017-11-16 09:34:05 -06:00
class EclipseState;
Framework for adding tables to INIT file - PVTO.
2016-11-16 09:12:59 -06:00
class Tables {
public:
Table Output: Don't Store ECL Keywords Internally This commit switches the internal implementation of the 'tab' and 'tabdims' vectors from being a mix of ECL keyword structures and std::vector<>s to being purely std::vector<>s. We remove the fwrite() member function and rather reimplement the feature in terms of new query member functions const std::vector<int>& tabdims() const const std::vector<double>& tab() const that return read-only references to internal data members.
2017-11-15 11:04:55 -06:00
explicit Tables( const UnitSystem& units);
void addDensity(const DensityTable& density);
Tables: Add Structurally Correct Water PVT Output This commit adds a new public member function Tables::addPVTTables(const EclipseState&) that calls into a new private member function Tables::addWaterPVTTables(const EclipseState&) to create structurally correct TAB vector entries from the PVTW input table data when water is an active phase in a simulation run. Specifically, the result array has the columns [ Pw, 1/Bw, Cw, 1/(Bw * mu_w), Cw - Cv ] in which 'Cw' denotes the water compressibility and 'Cv' denotes the water viscosibility. Column 4 and 5 follow ECLIPSE 100 conventions. Number of table rows equal to number of PVT regions. This result array differs from the existing Tables::addPVTW() member function in the treatment of viscosity and viscosibility data. We have verified the results with ECLIPSE 100. At present the function is not called by Flow's INIT file writer. Add a unit test to exercise the new member function.
2019-03-28 09:46:41 -05:00
/// Add normalised PVT function tables to INIT file's TAB vector.
///
/// \param[in] es Valid \c EclipseState object with accurate RUNSPEC
/// information on active phases and table dimensions ("TABDIMS").
///
/// \param[in] logihead Flag specifications identifying which tables
/// to output.
void addPVTTables(const EclipseState& es);
INIT File: Add Support for Writing Saturation Function Tables This commit extends the INIT file Table writing to also output the saturation function tables in normalised form. We support generating the INIT file's SGFN, SOFN, and SWFN tables--including the derivative information--for both two and three phases from both families of saturation function keywords (S{G,W}OF and S{G,W}FN + SOF{2,3}). We do not yet support generating the appropriate tables from input keyword SLGOF. We leverage the LinearisedOutputTable to abstract away some of the details of indexing into the linear 'tab' array and create a helper function to loop across saturation function regions whence each table generator need only be concerned about the specific data pertaining to that region's saturation function (i.e., the values of independent and dependent variates and number of active rows). We allocate the output tables according to information in the TABDIMS keyword, notably the number of saturation nodes (item 3 of TABDIMS). Generating the three-phase SOFN table, which has the same columns as the input table SOF3, in the case of family One (SGOF and SWOF) is slightly involved. In particular we need to join the SGOF and SWOF tables on common oil saturation values and derive/insert missing KroX data through piecewise linear interpolation in the appropriate input table. We defer the details of merging on common (and uniqe) oil saturation values to the standard library routine 'set_union()' which outputs repeated saturation values exactly once rather than for each occurrence. That way we only need to wrap the input tables in a simple class to facilitate look-up of oil saturation values and the mechanics of piecewise linear interpolation of the relative permeability column for oil. Due to this merging process, the number of rows in SOFN is twice the number of saturation nodes in this case. Since this support depends on being able to determine which phases are active in a particular run, what table sizes to use for the output and which keywords are being used to represent the saturation function tables we introduce a single new public member function void Tables::addSatFunc(const EclipseState& es) This function determines the run's active phases and dispatches to the new helper functions void Tables::addSatFunc_FamilyOne() void Tables::addSatFunc_FamilyTwo() according to which keyword family exists in the input deck. These functions in turn call additional helper functions to handle each phase table separately. For instance addSatFunc_FamilyOne() uses the helper function SatFunc::Oil::ThreePhase::fromSGOFandSWOF() to generate a three-phase SOFN table based on the information in the SGOF and SWOF tables. Information about slopes/derivatives for the piecewise interpolants of the dependent variates is computed through the helper function DifferentiateOutputTable::calcSlopes() whence the first entry of each derivative column is undefined (i.e., assigned the sentinel value 1e+20). This should arguably be zero instead. Further testing and comparison with INIT result sets generated by ECL will inform the decision here. We add unit tests for all combinations of number of active phases (two or three) and which saturation function keyword family is present in the simulation case. The unit tests use the tables from SPE 9 for keyword family One and the tables from SPE 1 for keyword family Two. Comparison data is extracted directly from the ECL INIT file in the case of the SPE 9 tables and derived from independent calculation for the SPE 1 tables.
2017-11-16 09:34:05 -06:00
/// Add normalised saturation function tables to INIT file's TAB
/// vector.
///
/// \param[in] es Valid \c EclipseState object with accurate RUNSPEC
/// information on active phases and table dimensions ("TABDIMS").
void addSatFunc(const EclipseState& es);
Table Output: Don't Store ECL Keywords Internally This commit switches the internal implementation of the 'tab' and 'tabdims' vectors from being a mix of ECL keyword structures and std::vector<>s to being purely std::vector<>s. We remove the fwrite() member function and rather reimplement the feature in terms of new query member functions const std::vector<int>& tabdims() const const std::vector<double>& tab() const that return read-only references to internal data members.
2017-11-15 11:04:55 -06:00
/// Acquire read-only reference to internal TABDIMS vector.
const std::vector<int>& tabdims() const;
/// Acquire read-only reference to internal TAB vector.
const std::vector<double>& tab() const;
Framework for adding tables to INIT file - PVTO.
2016-11-16 09:12:59 -06:00
private:
Table Output: Switch Naming Convention for Data Members Mostly to remove trailing underscores. The internal 'tabdims' vector in Opm::Tables has been renamed to 'm_tabdims' to avoid conflicting with the member function named 'tabdims'.
2017-11-27 03:25:48 -06:00
/// Convention for units of measure of the result set.
const UnitSystem& units;
/// Offset and size information for the tabular data.
std::vector<int> m_tabdims;
/// Linearised tabular data of PVT and saturation functions.
std::vector<double> data;
Framework for adding tables to INIT file - PVTO.
2016-11-16 09:12:59 -06:00
Table Output: Don't Store ECL Keywords Internally This commit switches the internal implementation of the 'tab' and 'tabdims' vectors from being a mix of ECL keyword structures and std::vector<>s to being purely std::vector<>s. We remove the fwrite() member function and rather reimplement the feature in terms of new query member functions const std::vector<int>& tabdims() const const std::vector<double>& tab() const that return read-only references to internal data members.
2017-11-15 11:04:55 -06:00
void addData(const std::size_t offset_index,
const std::vector<double>& new_data);
INIT File: Add Support for Writing Saturation Function Tables This commit extends the INIT file Table writing to also output the saturation function tables in normalised form. We support generating the INIT file's SGFN, SOFN, and SWFN tables--including the derivative information--for both two and three phases from both families of saturation function keywords (S{G,W}OF and S{G,W}FN + SOF{2,3}). We do not yet support generating the appropriate tables from input keyword SLGOF. We leverage the LinearisedOutputTable to abstract away some of the details of indexing into the linear 'tab' array and create a helper function to loop across saturation function regions whence each table generator need only be concerned about the specific data pertaining to that region's saturation function (i.e., the values of independent and dependent variates and number of active rows). We allocate the output tables according to information in the TABDIMS keyword, notably the number of saturation nodes (item 3 of TABDIMS). Generating the three-phase SOFN table, which has the same columns as the input table SOF3, in the case of family One (SGOF and SWOF) is slightly involved. In particular we need to join the SGOF and SWOF tables on common oil saturation values and derive/insert missing KroX data through piecewise linear interpolation in the appropriate input table. We defer the details of merging on common (and uniqe) oil saturation values to the standard library routine 'set_union()' which outputs repeated saturation values exactly once rather than for each occurrence. That way we only need to wrap the input tables in a simple class to facilitate look-up of oil saturation values and the mechanics of piecewise linear interpolation of the relative permeability column for oil. Due to this merging process, the number of rows in SOFN is twice the number of saturation nodes in this case. Since this support depends on being able to determine which phases are active in a particular run, what table sizes to use for the output and which keywords are being used to represent the saturation function tables we introduce a single new public member function void Tables::addSatFunc(const EclipseState& es) This function determines the run's active phases and dispatches to the new helper functions void Tables::addSatFunc_FamilyOne() void Tables::addSatFunc_FamilyTwo() according to which keyword family exists in the input deck. These functions in turn call additional helper functions to handle each phase table separately. For instance addSatFunc_FamilyOne() uses the helper function SatFunc::Oil::ThreePhase::fromSGOFandSWOF() to generate a three-phase SOFN table based on the information in the SGOF and SWOF tables. Information about slopes/derivatives for the piecewise interpolants of the dependent variates is computed through the helper function DifferentiateOutputTable::calcSlopes() whence the first entry of each derivative column is undefined (i.e., assigned the sentinel value 1e+20). This should arguably be zero instead. Further testing and comparison with INIT result sets generated by ECL will inform the decision here. We add unit tests for all combinations of number of active phases (two or three) and which saturation function keyword family is present in the simulation case. The unit tests use the tables from SPE 9 for keyword family One and the tables from SPE 1 for keyword family Two. Comparison data is extracted directly from the ECL INIT file in the case of the SPE 9 tables and derived from independent calculation for the SPE 1 tables.
2017-11-16 09:34:05 -06:00
/// Add saturation function tables corresponding to family I (SGOF,
/// SWOF) to the tabular data (TABDIMS and TAB vectors).
///
/// \param[in] es Valid \c EclipseState object with accurate table
/// dimensions ("TABDIMS" keyword) and an initialised \c
/// TableManager sub-object.
///
/// \param[in] gas Whether or not gas is active the current run.
///
/// \param[in] oil Whether or not oil is active the current run.
///
/// \param[in] wat Whether or not water is active the current run.
void addSatFunc_FamilyOne(const EclipseState& es,
const bool gas,
const bool oil,
const bool wat);
/// Add saturation function tables corresponding to family II (SGFN,
/// SOF{2,3}, SWFN) to the tabular data (TABDIMS and TAB vectors).
///
/// \param[in] es Valid \c EclipseState object with accurate table
/// dimensions ("TABDIMS" keyword) and an initialised \c
/// TableManager sub-object.
///
/// \param[in] gas Whether or not gas is active the current run.
///
/// \param[in] oil Whether or not oil is active the current run.
///
/// \param[in] wat Whether or not water is active the current run.
void addSatFunc_FamilyTwo(const EclipseState& es,
const bool gas,
const bool oil,
const bool wat);
Tables: Add Structurally Correct Water PVT Output This commit adds a new public member function Tables::addPVTTables(const EclipseState&) that calls into a new private member function Tables::addWaterPVTTables(const EclipseState&) to create structurally correct TAB vector entries from the PVTW input table data when water is an active phase in a simulation run. Specifically, the result array has the columns [ Pw, 1/Bw, Cw, 1/(Bw * mu_w), Cw - Cv ] in which 'Cw' denotes the water compressibility and 'Cv' denotes the water viscosibility. Column 4 and 5 follow ECLIPSE 100 conventions. Number of table rows equal to number of PVT regions. This result array differs from the existing Tables::addPVTW() member function in the treatment of viscosity and viscosibility data. We have verified the results with ECLIPSE 100. At present the function is not called by Flow's INIT file writer. Add a unit test to exercise the new member function.
2019-03-28 09:46:41 -05:00
Tables: Add Structurally Correct Gas PVT Output from PVDG This commit expands the public member function Tables::addPVTTables(const EclipseState&) to call into a new private member function Tables::addGasPVTTables(const EclipseState&) which will create structurally correct TAB vector entries from the PVDG (dry gas) input table data when gas is an active phase in a simulation run. Specifically, the result array has the columns [ Pg, 1/Bg, 1/(Bg*mu_g), d(1/Bg)/dPg, d(1/(Bg*mu_g))/dPg ] The number of table rows is equal to number of PVT regions times the number of pressure nodes declared in input keyword TABDIMS (NPPVT, Item 4). In other words, the result array is expanded to fill NPPVT rows per PVT region. Fill value +2.0e+20. We have verified the results with ECLIPSE 100. As an OPM extension, we will use the maximum number of active pressure nodes across all PVDG tables if the declared maximum pressure nodes in TABDIMS is too small. This will create a TAB vector that is not compatible with ECLIPSE, but which will nevertheless be useful in the context of ResInsight's flux calculation.
2019-03-28 12:42:03 -05:00
/// Add gas PVT tables (keywords PVDG and PVTG) to the tabular data
/// (TABDIMS and TAB vectors).
///
/// \param[in] es Valid \c EclipseState object with accurate table
/// dimensions ("TABDIMS" keyword) and an initialised \c
/// TableManager sub-object.
void addGasPVTTables(const EclipseState& es);
Tables: Add Structurally Correct Oil PVT Output from PVCDO This commit expands the public member function Tables::addPVTTables(const EclipseState&) to call into a new private member function Tables::addOilPVTTables(const EclipseState&) which will create structurally correct TAB vector entries from the PVCDO input table data when oil is an active phase in a simulation run. Specifically, the result array has the columns [ Po, Bo, Co, mu_o, Cv ] in which 'Co' denotes the oil compressibility and 'Cv' denotes the oil viscosibility. The number of table rows is equal to number of PVT regions times the number of pressure nodes declared in input keyword TABDIMS (NPPVT, Item 4). In other words, the result array is a copy of the input table but expanded to fill NPPVT rows per PVT region. Fill value -1.0e+20. We have verified the results with ECLIPSE 100. At present the function is not called by Flow's INIT file writer.
2019-03-28 10:58:03 -05:00
/// Add oil PVT tables (keywords PVCDO, PVDO and PVTO) to the
/// tabular data (TABDIMS and TAB vectors).
///
/// \param[in] es Valid \c EclipseState object with accurate table
/// dimensions ("TABDIMS" keyword) and an initialised \c
/// TableManager sub-object.
void addOilPVTTables(const EclipseState& es);
Tables: Add Structurally Correct Water PVT Output This commit adds a new public member function Tables::addPVTTables(const EclipseState&) that calls into a new private member function Tables::addWaterPVTTables(const EclipseState&) to create structurally correct TAB vector entries from the PVTW input table data when water is an active phase in a simulation run. Specifically, the result array has the columns [ Pw, 1/Bw, Cw, 1/(Bw * mu_w), Cw - Cv ] in which 'Cw' denotes the water compressibility and 'Cv' denotes the water viscosibility. Column 4 and 5 follow ECLIPSE 100 conventions. Number of table rows equal to number of PVT regions. This result array differs from the existing Tables::addPVTW() member function in the treatment of viscosity and viscosibility data. We have verified the results with ECLIPSE 100. At present the function is not called by Flow's INIT file writer. Add a unit test to exercise the new member function.
2019-03-28 09:46:41 -05:00
/// Add water PVT tables (keyword PVTW) to the tabular data (TABDIMS
/// and TAB vectors).
///
/// \param[in] es Valid \c EclipseState object with accurate table
/// dimensions ("TABDIMS" keyword) and an initialised \c
/// TableManager sub-object.
void addWaterPVTTables(const EclipseState& es);
Framework for adding tables to INIT file - PVTO.
2016-11-16 09:12:59 -06:00
};
}
Table Linearisation: Remove Original PVT Functions This commit removes the original member functions void Tables::addPVTO() void Tables::addPVTW() void Tables::addPVTG() since these are no longer needed. The PVT tables are now defined in terms of the 'addPVTTables()' member function While here, also remove the fwrite() free function which was defined in terms of LibECL types. Update the unit test accordingly.
2019-10-01 17:17:14 -05:00
#endif // OUTPUT_TABLES_HPP
Reference in New Issue Copy Permalink