ParallelEclipseState.hpp

/*
  Copyright 2019 Equinor AS.

  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 PARALLEL_ECLIPSE_STATE_HPP
#define PARALLEL_ECLIPSE_STATE_HPP

#include <dune/common/version.hh>
#include <opm/input/eclipse/EclipseState/EclipseState.hpp>
#include <opm/input/eclipse/EclipseState/Grid/TranCalculator.hpp>
#include <dune/common/parallel/mpihelper.hh>

#include <opm/simulators/utils/ParallelCommunication.hpp>

#include <functional>

namespace Opm {


class ParallelFieldPropsManager : public FieldPropsManager {
public:
    friend class ParallelEclipseState; 
    template<class Grid>
    friend class PropsDataHandle;

    explicit ParallelFieldPropsManager(FieldPropsManager& manager);

    ParallelFieldPropsManager(FieldPropsManager& manager, Parallel::Communication comm);

    std::vector<int> actnum() const override;

    void reset_actnum(const std::vector<int>& actnum) override;

    std::vector<double> porv(bool global = false) const override;

    const std::vector<int>& get_int(const std::string& keyword) const override;

    const std::vector<double>& get_double(const std::string& keyword) const override;

    std::vector<int> get_global_int(const std::string& keyword) const override;

    std::vector<double> get_global_double(const std::string& keyword) const override;

    bool has_int(const std::string& keyword) const override;

    bool has_double(const std::string& keyword) const override;

    std::vector<std::string> fip_regions() const override;

    template<class T>
    void resetCartesianMapper(const T* mapper)
    {
        // Note: mapper would usually be a CartesianIndexMapper. However, to support also
        // the case of a distributed level zero grid in a CpGrid with LGRs, mapper will be
        // Opm::LevelCartesianIndexMapper. This change allows access to the Cartesian indices
        // of the distributed level zero grid, where the field properties are given - for now.
        // In case of supporting LGR field properties, this need to be adapted, to access instead
        // each local/level Cartesian index set.
        m_activeSize = [mapper]() { return mapper->compressedSize(/*level = */ 0); };
        m_local2Global = [mapper](int localIdx) { return mapper->cartesianIndex(localIdx, /* level = */ 0); };
    }

    bool tran_active(const std::string& keyword) const override;

    void apply_tran(const std::string& keyword, std::vector<double>& trans) const override;

    void copyTran(const FieldPropsManager& from)
    {
        m_tran = from.getTran();
    }

    template<class Serializer>
    void serializeOp(Serializer& serializer)
    {
        serializer(m_tran);
    }

protected:
    std::map<std::string, Fieldprops::FieldData<int>> m_intProps; 
    std::map<std::string, Fieldprops::FieldData<double>> m_doubleProps; 
    FieldPropsManager& m_manager; 
    Parallel::Communication m_comm; 
    std::function<int(void)> m_activeSize; 
    std::function<int(const int)> m_local2Global; 
    std::unordered_map<std::string, Fieldprops::TranCalculator> m_tran; 
};


class ParallelEclipseState : public EclipseState {
    template<class Grid>
    friend class PropsDataHandle;
public:
    ParallelEclipseState(Parallel::Communication comm);

    ParallelEclipseState(const Deck& deck);

    ParallelEclipseState(const Deck& deck, Parallel::Communication comm);

    void switchToGlobalProps();

    void switchToDistributedProps();

    const FieldPropsManager& fieldProps() const override;

    const FieldPropsManager& globalFieldProps() const override;

    void computeFipRegionStatistics() override;

    const EclipseGrid& getInputGrid() const override;

    template<class T>
    void resetCartesianMapper(const T* mapper)
    {
        m_fieldProps.resetCartesianMapper(mapper);
    }
private:
    bool m_parProps = false; 
    ParallelFieldPropsManager m_fieldProps; 
    Parallel::Communication m_comm; 
};


} // end namespace Opm
#endif // PARALLEL_ECLIPSE_STATE_HPP