Regdims.hpp

/*
  Copyright (C) 2015 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
  MERCHANREGILITY 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 REGDIMS_HPP
#define REGDIMS_HPP

#include <cstddef>

namespace Opm {

    class Deck;
    class DeckKeyword;
    class DeckRecord;

/*
  The Regdims class is a small utility class designed to hold on to
  the values from the REGDIMS keyword.
*/

    class Regdims {
    public:

        Regdims();

        explicit Regdims(const Deck& deck);

        Regdims(std::size_t ntfip , std::size_t nmfipr , std::size_t nrfregr , std::size_t ntfreg , std::size_t nplmix) :
            m_NTFIP( ntfip ),
            m_NMFIPR( nmfipr ),
            m_NRFREG( nrfregr ),
            m_NTFREG(  ntfreg ),
            m_NPLMIX( nplmix )
        {}

        static Regdims serializationTestObject()
        {
            return Regdims(1, 2, 3, 4, 5);
        }


        std::size_t getNTFIP() const {
            return m_NTFIP;
        }


        std::size_t getNMFIPR() const {
            return m_NMFIPR;
        }


        std::size_t getNRFREG() const {
            return m_NRFREG;
        }


        std::size_t getNTFREG() const {
            return m_NTFREG;
        }


        std::size_t getNPLMIX() const {
            return m_NPLMIX;
        }


        bool operator==(const Regdims& data) const {
            return this->getNTFIP() == data.getNTFIP() &&
                   this->getNMFIPR() == data.getNMFIPR() &&
                   this->getNRFREG() == data.getNRFREG() &&
                   this->getNTFREG() == data.getNTFREG() &&
                   this->getNPLMIX() == data.getNPLMIX();
        }

        template<class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(m_NTFIP);
            serializer(m_NMFIPR);
            serializer(m_NRFREG);
            serializer(m_NTFREG);
            serializer(m_NPLMIX);
        }

    private:
        std::size_t m_NTFIP;
        std::size_t m_NMFIPR;
        std::size_t m_NRFREG;
        std::size_t m_NTFREG;
        std::size_t m_NPLMIX;
    };
}


#endif