LogiHEAD.hpp

/*
  Copyright 2019 Equinor ASA.
  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_LOGIHEAD_HEADER_INCLUDED
#define OPM_LOGIHEAD_HEADER_INCLUDED

#include <vector>

namespace Opm {

    class OilVaporizationProperties;

} // namespace Opm

namespace Opm::RestartIO {

    class LogiHEAD
    {
    public:
        struct PVTModel
        {
            bool isLiveOil { false };

            bool isWetGas { false };

            bool constComprOil { false };
        };

        struct SatfuncFlags
        {
            bool useDirectionalRelPerm { false };

            bool useReversibleRelPerm { true };

            bool useEndScale { false };

            bool useDirectionalEPS { false };

            bool useReversibleEPS { true  };

            bool useAlternateEPS { false };
        };

        LogiHEAD();
        ~LogiHEAD() = default;

        LogiHEAD(const LogiHEAD& rhs) = default;
        LogiHEAD(LogiHEAD&& rhs) = default;

        LogiHEAD& operator=(const LogiHEAD& rhs) = default;
        LogiHEAD& operator=(LogiHEAD&& rhs) = default;

        LogiHEAD& variousParam(const bool e300_radial,
                               const bool e100_radial,
                               const int  nswlmx,
                               const bool enableHyster,
                               const bool hasTemp = false);

        LogiHEAD& phaseMixing(const OilVaporizationProperties& oilvap);

        LogiHEAD& pvtModel(const PVTModel& pvt);

        LogiHEAD& saturationFunction(const SatfuncFlags& satfunc);

        LogiHEAD& network(const int maxNoNodes);

        const std::vector<bool>& data() const
        {
            return this->data_;
        }

    private:
        std::vector<bool> data_;
    };

} // Opm::RestartIO

#endif // OPM_LOGIHEAD_HEADER_INCLUDED