ECLResultData.hpp

Go to the documentation of this file.

/*
  Copyright 2016, 2017 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 OPM_ECLRESULTDATA_HEADER_INCLUDED
#define OPM_ECLRESULTDATA_HEADER_INCLUDED
 
#include <memory>
#include <string>
#include <vector>
 
#include <boost/filesystem/path.hpp>
 
 
extern "C" {
    typedef struct ecl_file_struct ecl_file_type;
} // extern "C"
 
namespace Opm {
 
    class ECLGraph;
 
    class ECLRestartData
    {
    public:
        ECLRestartData() = delete;
 
        explicit ECLRestartData(boost::filesystem::path rstrt);
 
        explicit ECLRestartData(std::shared_ptr<ecl_file_type> rstrt);
 
        ECLRestartData(const ECLRestartData& rhs);
 
        ECLRestartData(ECLRestartData&& rhs);
 
        ECLRestartData& operator=(const ECLRestartData& rhs);
 
        ECLRestartData& operator=(ECLRestartData&& rhs);
 
        ~ECLRestartData();
 
        bool selectReportStep(const int step) const;
 
        bool haveKeywordData(const std::string& vector,
                             const std::string& gridID = "") const;
 
        template <typename T>
        std::vector<T>
        keywordData(const std::string& vector,
                    const std::string& gridID = "") const;
 
    private:
        class Impl;
 
        std::unique_ptr<Impl> pImpl_;
    };
 
    class ECLInitFileData
    {
    public:
        ECLInitFileData() = delete;
 
        explicit ECLInitFileData(boost::filesystem::path initFile);
 
        explicit ECLInitFileData(std::shared_ptr<ecl_file_type> initFile);
 
        ECLInitFileData(const ECLInitFileData& rhs);
 
        ECLInitFileData(ECLInitFileData&& rhs);
 
        ECLInitFileData& operator=(const ECLInitFileData& rhs);
 
        ECLInitFileData& operator=(ECLInitFileData&& rhs);
 
        ~ECLInitFileData();
 
        bool haveKeywordData(const std::string& vector,
                             const std::string& gridID = "") const;
 
        template <typename T>
        std::vector<T>
        keywordData(const std::string& vector,
                    const std::string& gridID = "") const;
 
        // Grant class ECLGraph privileged access to getRawFilePtr().
        friend class ECLGraph;
 
    private:
        class Impl;
 
        std::unique_ptr<Impl> pImpl_;
 
        const ecl_file_type* getRawFilePtr() const;
    };
} // namespace Opm
 
#endif  // OPM_ECLRESULTDATA_HEADER_INCLUDED