EclUtil.hpp

Go to the documentation of this file.

/*
   Copyright 2019 Equinor 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 OPM_IO_ECLUTIL_HPP
#define OPM_IO_ECLUTIL_HPP
 
#include <opm/io/eclipse/EclIOdata.hpp>
#include <opm/common/utility/FileSystem.hpp>
 
#include <string>
#include <tuple>
#include <vector>
#include <functional>
 
namespace Opm { namespace EclIO {
 
    int flipEndianInt(int num);
    int64_t flipEndianLongInt(int64_t num);
    float flipEndianFloat(float num);
    double flipEndianDouble(double num);
    bool isEOF(std::fstream* fileH);
    bool fileExists(const std::string& filename);
    bool isFormatted(const std::string& filename);
    bool is_number(const std::string& numstr);
 
    bool isEqualCaseInsensitive(const std::string& string1, const std::string& string2);
    Opm::filesystem::path findFileCaseInsensitive(const Opm::filesystem::path& folder, const std::string& filename);
 
    std::tuple<int, int> block_size_data_binary(eclArrType arrType);
    std::tuple<int, int, int> block_size_data_formatted(eclArrType arrType);
 
    std::string trimr(const std::string &str1);
 
    uint64_t sizeOnDiskBinary(int64_t num, Opm::EclIO::eclArrType arrType, int elementSize);
    uint64_t sizeOnDiskFormatted(const int64_t num, Opm::EclIO::eclArrType arrType, int elementSize);
 
    void readBinaryHeader(std::fstream& fileH, std::string& tmpStrName,
                      int& tmpSize, std::string& tmpStrType);
 
    void readBinaryHeader(std::fstream& fileH, std::string& arrName,
                      int64_t& size, Opm::EclIO::eclArrType &arrType, int& elementSize);
 
    void readFormattedHeader(std::fstream& fileH, std::string& arrName,
                      int64_t &num, Opm::EclIO::eclArrType &arrType, int& elementSize);
 
    template<typename T, typename T2>
    std::vector<T> readBinaryArray(std::fstream& fileH, const int64_t size, Opm::EclIO::eclArrType type,
                               std::function<T(T2)>& flip, int elementSize);
 
    std::vector<int> readBinaryInteArray(std::fstream &fileH, const int64_t size);
    std::vector<float> readBinaryRealArray(std::fstream& fileH, const int64_t size);
    std::vector<double> readBinaryDoubArray(std::fstream& fileH, const int64_t size);
    std::vector<bool> readBinaryLogiArray(std::fstream &fileH, const int64_t size);
    std::vector<unsigned int> readBinaryRawLogiArray(std::fstream &fileH, const int64_t size);
    std::vector<std::string> readBinaryCharArray(std::fstream& fileH, const int64_t size);
    std::vector<std::string> readBinaryC0nnArray(std::fstream& fileH, const int64_t size, int elementSize);
 
    template<typename T>
    std::vector<T> readFormattedArray(const std::string& file_str, const int size, int64_t fromPos,
                                       std::function<T(const std::string&)>& process);
 
    std::vector<int> readFormattedInteArray(const std::string& file_str, const int64_t size, int64_t fromPos);
 
    std::vector<std::string> readFormattedCharArray(const std::string& file_str, const int64_t size,
                                                    int64_t fromPos, int elementSize);
 
    std::vector<float> readFormattedRealArray(const std::string& file_str, const int64_t size, int64_t fromPos);
    std::vector<std::string> readFormattedRealRawStrings(const std::string& file_str, const int64_t size, int64_t fromPos);
 
    std::vector<bool> readFormattedLogiArray(const std::string& file_str, const int64_t size, int64_t fromPos);
    std::vector<double> readFormattedDoubArray(const std::string& file_str, const int64_t size, int64_t fromPos);
 
}} // namespace Opm::EclIO
 
#endif // OPM_IO_ECLUTIL_HPP