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

#include <vector>
#include <string>

#include <opm/parser/eclipse/Deck/Deck.hpp>
#include <opm/parser/eclipse/Deck/DeckItem.hpp>
#include <opm/parser/eclipse/Deck/DeckKeyword.hpp>
#include <opm/parser/eclipse/Deck/DeckRecord.hpp>
#include <opm/parser/eclipse/EclipseState/Grid/GridProperties.hpp>
#include <opm/parser/eclipse/EclipseState/Grid/GridProperty.hpp>
#include <opm/parser/eclipse/EclipseState/Tables/TableManager.hpp>

namespace Opm {

    class Box;
    class BoxManager;
    class Deck;
    class DeckItem;
    class DeckKeyword;
    class DeckRecord;
    class EclipseGrid;
    class Section;
    class TableManager;
    class UnitSystem;

    /// Class representing properties on 3D grid for use in EclipseState.
    class Eclipse3DProperties
    {
    public:

        Eclipse3DProperties() = default;
        Eclipse3DProperties(const Deck& deck,
                            const TableManager& tableManager,
                            const EclipseGrid& eclipseGrid);


        std::vector< int > getRegions( const std::string& keyword ) const;
        std::string getDefaultRegionKeyword() const;

        const GridProperty<int>&      getIntGridProperty     ( const std::string& keyword ) const;
        const GridProperty<double>&   getDoubleGridProperty  ( const std::string& keyword ) const;

        const GridProperties<int>& getIntProperties() const;
        const GridProperties<double>& getDoubleProperties() const;

        bool hasDeckIntGridProperty(const std::string& keyword) const;
        bool hasDeckDoubleGridProperty(const std::string& keyword) const;
        bool supportsGridProperty(const std::string& keyword) const;
        MessageContainer getMessageContainer();

    private:
        const GridProperty<int>& getRegion(const DeckItem& regionItem) const;
        void processGridProperties(const Deck& deck,
                                   const EclipseGrid& eclipseGrid);

        void scanSection(const Section& section,
                         const EclipseGrid& eclipseGrid);

        void handleADDKeyword(     const DeckKeyword& deckKeyword, BoxManager& boxManager);
        void handleBOXKeyword(     const DeckKeyword& deckKeyword, BoxManager& boxManager);
        void handleCOPYKeyword(    const DeckKeyword& deckKeyword, BoxManager& boxManager);
        void handleENDBOXKeyword(  BoxManager& boxManager);
        void handleEQUALSKeyword(  const DeckKeyword& deckKeyword, BoxManager& boxManager);
        void handleMULTIPLYKeyword(const DeckKeyword& deckKeyword, BoxManager& boxManager);

        void handleADDREGKeyword(  const DeckKeyword& deckKeyword );
        void handleCOPYREGKeyword( const DeckKeyword& deckKeyword );
        void handleEQUALREGKeyword(const DeckKeyword& deckKeyword );
        void handleMULTIREGKeyword(const DeckKeyword& deckKeyword );
        void handleOPERATEKeyword( const DeckKeyword& deckKeyword, BoxManager& boxManager);

        void loadGridPropertyFromDeckKeyword(const Box& inputBox,
                                             const DeckKeyword& deckKeyword);

        void setKeywordBox(const DeckKeyword& deckKeyword, const DeckRecord&, BoxManager& boxManager);

        std::string            m_defaultRegion;
        UnitSystem             m_deckUnitSystem;
        GridProperties<int>    m_intGridProperties;
        GridProperties<double> m_doubleGridProperties;
    };
}

#endif // OPM_ECLIPSE_PROPERTIES_HPP