OilfieldToolsNet/opm-common
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
release/2020.10
opm-common/opm/io/eclipse/EclOutput.hpp

119 lines
3.5 KiB
C++
Raw Permalink Normal View History

added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
/*
Copyright 2019 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/>.
*/
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
#ifndef OPM_IO_ECLOUTPUT_HPP
#define OPM_IO_ECLOUTPUT_HPP
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
#include <fstream>
Ecl Output: Add write<>() Support for PaddedOutputString<8> This is in preparation of using the EclOutput output facility in RestartIO::save()
2019-05-02 14:14:11 -05:00
#include <ios>
#include <string>
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
#include <typeinfo>
Ecl Output: Add write<>() Support for PaddedOutputString<8> This is in preparation of using the EclOutput output facility in RestartIO::save()
2019-05-02 14:14:11 -05:00
#include <vector>
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
#include <opm/io/eclipse/EclIOdata.hpp>
Ecl Output: Add write<>() Support for PaddedOutputString<8> This is in preparation of using the EclOutput output facility in RestartIO::save()
2019-05-02 14:14:11 -05:00
#include <opm/io/eclipse/PaddedOutputString.hpp>
Adding support for large arrays using X231 format extension - EclIO classes have been updated to support arrays with size beyond numeric limits for integers - Output of arrays having 2^31 or more elements is facilitated by using a pair of headers - The first header is of type X231, second should have the actual type - The large array format extension is documented in the Eclipse File format manual
2020-03-15 04:27:50 -05:00
#include <iostream>
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
ECLIPSE I/O: Rename Namespace Opm::ecl -> Opm::EclIO This reduces the risk of conflicting with the 'ecl' namespace from LibECL, especially when the latter name is used from within the Opm namespace.
2019-05-24 08:26:01 -05:00
namespace Opm { namespace EclIO { namespace OutputStream {
Restart Output: Add File Management Facility This commit introduces a new class, Opm::ecl::OutputStream::Restart that handles the details of opening restart output streams (all combinations of formatted/unformatted and unified/separate), as well as correctly positioning the stream 'put' indicator if we're opening an existing unified restart file. In most cases, this will be a simple append operation (std::ios_base::app), but there are some subtleties that require more precise control. The new class is befriended by EclOutput and ERst in order to access private member functions and data members of these classes. That is needed in order to handle file resize operations since some of the requisite information is only available in those two classes. We use Boost.Filesystem to implement file resize, as if by POSIX function ::truncate(), and also to simplify filename generation. These calls can be switched to std::filesystem once the project requires C++17. Intended use of the Restart class is Restart rst(resultSet, formatted, unified); rst.prepareStep(17); // Report step/SEQNUM 17. rst.write("INTEHEAD", ihead); // ... The 'prepareStep' operation opens the file stream (if needed) and also outputs a SEQNUM record in the case of a unified output stream. Moreover, the 'resultSet' is a pair of output directory and case's base name (e.g., "./mpi.np4/2019.05.14.01" and "NORNE_ATW2013") and the formatted/unified flags are bools wrapped in structures. The Restart class is intended to take over the role of the 'filename' string parameter of RestartIO::save(). Add a set of unit tests to demontrate usage and abilities of class Restart.
2019-05-27 06:03:57 -05:00
class Restart;
Add File Manager Stream for Summary Specification This commit introduces a new OutputStream class for representing the summary specification file (.SMSPEC). The stream is constructed with constant data (output directory, basename, start date &c), and provides a single write() member function that outputs a summary specification. Each call to write rewinds the underlying stream's output position. Class EclOutput grants friendship to the new output stream class in order to support easy stream rewinding. Add a unit test to exercise the new class.
2019-09-30 12:00:54 -05:00
class SummarySpecification;
Restart Output: Add File Management Facility This commit introduces a new class, Opm::ecl::OutputStream::Restart that handles the details of opening restart output streams (all combinations of formatted/unformatted and unified/separate), as well as correctly positioning the stream 'put' indicator if we're opening an existing unified restart file. In most cases, this will be a simple append operation (std::ios_base::app), but there are some subtleties that require more precise control. The new class is befriended by EclOutput and ERst in order to access private member functions and data members of these classes. That is needed in order to handle file resize operations since some of the requisite information is only available in those two classes. We use Boost.Filesystem to implement file resize, as if by POSIX function ::truncate(), and also to simplify filename generation. These calls can be switched to std::filesystem once the project requires C++17. Intended use of the Restart class is Restart rst(resultSet, formatted, unified); rst.prepareStep(17); // Report step/SEQNUM 17. rst.write("INTEHEAD", ihead); // ... The 'prepareStep' operation opens the file stream (if needed) and also outputs a SEQNUM record in the case of a unified output stream. Moreover, the 'resultSet' is a pair of output directory and case's base name (e.g., "./mpi.np4/2019.05.14.01" and "NORNE_ATW2013") and the formatted/unified flags are bools wrapped in structures. The Restart class is intended to take over the role of the 'filename' string parameter of RestartIO::save(). Add a set of unit tests to demontrate usage and abilities of class Restart.
2019-05-27 06:03:57 -05:00
}}}
ECLIPSE I/O: Rename Namespace Opm::ecl -> Opm::EclIO This reduces the risk of conflicting with the 'ecl' namespace from LibECL, especially when the latter name is used from within the Opm namespace.
2019-05-24 08:26:01 -05:00
namespace Opm { namespace EclIO {
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
class EclOutput
{
public:
Ecl Output: Add Support for Opening File in Specific Mode This commit extends the EclOutput constructor to support letting the client specify a particular open mode. This in turn prepares using EclOutput as the basis for a restart file writer. Passing mode=openmode::out is the common case for a new restart file, while mode=openmode::app is the common case for an existing restart file.
2019-05-02 15:03:08 -05:00
EclOutput(const std::string& filename,
const bool formatted,
const std::ios_base::openmode mode = std::ios::out);
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
template<typename T>
void write(const std::string& name,
const std::vector<T>& data)
{
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
eclArrType arrType = MESS;
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
if (typeid(T) == typeid(int))
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
arrType = INTE;
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
else if (typeid(T) == typeid(float))
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
arrType = REAL;
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
else if (typeid(T) == typeid(double))
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
arrType = DOUB;
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
else if (typeid(T) == typeid(bool))
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
arrType = LOGI;
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
else if (typeid(T) == typeid(char))
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
arrType = MESS;
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
if (isFormatted)
{
writeFormattedHeader(name, data.size(), arrType);
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
if (arrType != MESS)
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
writeFormattedArray(data);
}
else
{
writeBinaryHeader(name, data.size(), arrType);
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
if (arrType != MESS)
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
writeBinaryArray(data);
}
}
Ecl Output: Add Support for Generating Messages Specifically, add a member function EclOutput::message(const std::string&) that outputs the string as an 'eclArrType::MESS'. This is in order to support outputting 'STARTSOL' and 'ENDSOL' demarcations in a restart file.
2019-05-27 06:03:13 -05:00
void message(const std::string& msg);
EclOutput: Add Stream Flushing Operation Calls '.flush()' on the contained 'ofstream' object. Needed as a means of ensuring that bits in the internal buffers of the I/O system are promptly output to permanent storage. This, in turn, is needed in upcoming work on the summary writing feature.
2019-10-05 07:19:55 -05:00
void flushStream();
Ecl Output: Add Support for Generating Messages Specifically, add a member function EclOutput::message(const std::string&) that outputs the string as an 'eclArrType::MESS'. This is in order to support outputting 'STARTSOL' and 'ENDSOL' demarcations in a restart file.
2019-05-27 06:03:13 -05:00
Restart Output: Add File Management Facility This commit introduces a new class, Opm::ecl::OutputStream::Restart that handles the details of opening restart output streams (all combinations of formatted/unformatted and unified/separate), as well as correctly positioning the stream 'put' indicator if we're opening an existing unified restart file. In most cases, this will be a simple append operation (std::ios_base::app), but there are some subtleties that require more precise control. The new class is befriended by EclOutput and ERst in order to access private member functions and data members of these classes. That is needed in order to handle file resize operations since some of the requisite information is only available in those two classes. We use Boost.Filesystem to implement file resize, as if by POSIX function ::truncate(), and also to simplify filename generation. These calls can be switched to std::filesystem once the project requires C++17. Intended use of the Restart class is Restart rst(resultSet, formatted, unified); rst.prepareStep(17); // Report step/SEQNUM 17. rst.write("INTEHEAD", ihead); // ... The 'prepareStep' operation opens the file stream (if needed) and also outputs a SEQNUM record in the case of a unified output stream. Moreover, the 'resultSet' is a pair of output directory and case's base name (e.g., "./mpi.np4/2019.05.14.01" and "NORNE_ATW2013") and the formatted/unified flags are bools wrapped in structures. The Restart class is intended to take over the role of the 'filename' string parameter of RestartIO::save(). Add a set of unit tests to demontrate usage and abilities of class Restart.
2019-05-27 06:03:57 -05:00
friend class OutputStream::Restart;
Add File Manager Stream for Summary Specification This commit introduces a new OutputStream class for representing the summary specification file (.SMSPEC). The stream is constructed with constant data (output directory, basename, start date &c), and provides a single write() member function that outputs a summary specification. Each call to write rewinds the underlying stream's output position. Class EclOutput grants friendship to the new output stream class in order to support easy stream rewinding. Add a unit test to exercise the new class.
2019-09-30 12:00:54 -05:00
friend class OutputStream::SummarySpecification;
Restart Output: Add File Management Facility This commit introduces a new class, Opm::ecl::OutputStream::Restart that handles the details of opening restart output streams (all combinations of formatted/unformatted and unified/separate), as well as correctly positioning the stream 'put' indicator if we're opening an existing unified restart file. In most cases, this will be a simple append operation (std::ios_base::app), but there are some subtleties that require more precise control. The new class is befriended by EclOutput and ERst in order to access private member functions and data members of these classes. That is needed in order to handle file resize operations since some of the requisite information is only available in those two classes. We use Boost.Filesystem to implement file resize, as if by POSIX function ::truncate(), and also to simplify filename generation. These calls can be switched to std::filesystem once the project requires C++17. Intended use of the Restart class is Restart rst(resultSet, formatted, unified); rst.prepareStep(17); // Report step/SEQNUM 17. rst.write("INTEHEAD", ihead); // ... The 'prepareStep' operation opens the file stream (if needed) and also outputs a SEQNUM record in the case of a unified output stream. Moreover, the 'resultSet' is a pair of output directory and case's base name (e.g., "./mpi.np4/2019.05.14.01" and "NORNE_ATW2013") and the formatted/unified flags are bools wrapped in structures. The Restart class is intended to take over the role of the 'filename' string parameter of RestartIO::save(). Add a set of unit tests to demontrate usage and abilities of class Restart.
2019-05-27 06:03:57 -05:00
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
private:
replacing long int and unsigned long int - long int -> int64_t - unsigned long int -> uint64_t All EclIO classes and associated tests has been updated.
2020-03-23 08:27:39 -05:00
void writeBinaryHeader(const std::string& arrName, int64_t size, eclArrType arrType);
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
template <typename T>
void writeBinaryArray(const std::vector<T>& data);
void writeBinaryCharArray(const std::vector<std::string>& data);
Ecl Output: Add write<>() Support for PaddedOutputString<8> This is in preparation of using the EclOutput output facility in RestartIO::save()
2019-05-02 14:14:11 -05:00
void writeBinaryCharArray(const std::vector<PaddedOutputString<8>>& data);
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
void writeFormattedHeader(const std::string& arrName, int size, eclArrType arrType);
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
template <typename T>
void writeFormattedArray(const std::vector<T>& data);
void writeFormattedCharArray(const std::vector<std::string>& data);
Ecl Output: Add write<>() Support for PaddedOutputString<8> This is in preparation of using the EclOutput output facility in RestartIO::save()
2019-05-02 14:14:11 -05:00
void writeFormattedCharArray(const std::vector<PaddedOutputString<8>>& data);
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
Adding support for large arrays using X231 format extension - EclIO classes have been updated to support arrays with size beyond numeric limits for integers - Output of arrays having 2^31 or more elements is facilitated by using a pair of headers - The first header is of type X231, second should have the actual type - The large array format extension is documented in the Eclipse File format manual
2020-03-15 04:27:50 -05:00
void writeArrayType(const eclArrType arrType);
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
std::string make_real_string(float value) const;
std::string make_doub_string(double value) const;
bool isFormatted;
Ecl Output: Add Support for Opening File in Specific Mode This commit extends the EclOutput constructor to support letting the client specify a particular open mode. This in turn prepares using EclOutput as the basis for a restart file writer. Passing mode=openmode::out is the common case for a new restart file, while mode=openmode::app is the common case for an existing restart file.
2019-05-02 15:03:08 -05:00
std::ofstream ofileH;
added: EclOutput class for writing ECL files
2019-03-28 06:47:22 -05:00
};
template<>
void EclOutput::write<std::string>(const std::string& name,
const std::vector<std::string>& data);
Ecl Output: Add write<>() Support for PaddedOutputString<8> This is in preparation of using the EclOutput output facility in RestartIO::save()
2019-05-02 14:14:11 -05:00
template <>
void EclOutput::write<PaddedOutputString<8>>
(const std::string& name,
const std::vector<PaddedOutputString<8>>& data);
ECLIPSE I/O: Rename Namespace Opm::ecl -> Opm::EclIO This reduces the risk of conflicting with the 'ecl' namespace from LibECL, especially when the latter name is used from within the Opm namespace.
2019-05-24 08:26:01 -05:00
}} // namespace Opm::EclIO
Move ECLIPSE I/O Into Main OPM Common Library This makes the facility usable for the restart read/write code. Specifically, import the I/O classes into namespace Opm::ecl, and place the files in physical location opm/io/eclipse, and move the test utilities to new top-level directory 'test_util/'. While here, discontinue the 'testutil' static library since most of its features are now available in the main 'opmcommon' library. This does entail compiling a few of the test_util/ CPP files multiple times, and adding the objects to each executable independently.
2019-05-02 08:01:20 -05:00
#endif // OPM_IO_ECLOUTPUT_HPP
Reference in New Issue Copy Permalink