EclFilesComparator.hpp

/*
   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 ECLFILESCOMPARATOR_HPP
#define ECLFILESCOMPARATOR_HPP

#include "Deviation.hpp"

#include <map>
#include <stddef.h>
#include <string>
#include <vector>

namespace Opm { namespace EclIO {
    class EGrid;
}} // namespace Opm::ecl

class ECLFilesComparator {
public:
    ECLFilesComparator(const std::string& basename1,
                       const std::string& basename2,
                       double absTolerance, double relTolerance);

    void throwOnErrors(bool dothrow) {
        throwOnError = dothrow;
    }

    void doAnalysis(bool analize) {
        analysis = analize;
    }

    size_t getNoErrors() const {
        return num_errors;
    }

    double getAbsTolerance() const {
        return absTolerance;
    }
    double getRelTolerance() const {
        return relTolerance;
    }

    static Deviation calculateDeviations(double val1, double val2);
    static double median(std::vector<double> vec);
    static double average(const std::vector<double>& vec);

protected:
    bool throwOnError = true; 
    bool analysis = false; 
    std::map<std::string, std::vector<Deviation>> deviations;
    mutable size_t num_errors = 0;

    std::string rootName1, rootName2;

    template <typename T>
    void printValuesForCell(const std::string& keyword,
                            const std::string& reference,
                            size_t kw_size,
                            size_t cell,
                            const Opm::EclIO::EGrid *grid,
                            const T& value1,
                            const T& value2) const;

private:
    double absTolerance      = 0;
    double relTolerance      = 0;
};

#endif