ConvergenceOutputConfiguration.hpp

/*
  Copyright 2022 Equinor 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 CONVERGENCE_OUTPUT_CONFIGURATION_HPP
#define CONVERGENCE_OUTPUT_CONFIGURATION_HPP

#include <cstddef>
#include <string_view>

namespace Opm {

class ConvergenceOutputConfiguration
{
public:
    enum class Option : unsigned char {
        None = 0,
        Steps = 1 << 1,
        Iterations = 1 << 2,
    };

    explicit ConvergenceOutputConfiguration(std::string_view options,
                                            std::string_view optionName = "");

    bool any() const
    {
        return this->flag_ != std::byte{0};
    }

    bool want(const Option opt) const
    {
        return std::to_integer<int>(this->flag_ & static_cast<std::byte>(opt)) != 0;
    }

private:
    std::byte flag_{0};
};

} // namespace Opm

#endif // CONVERGENCE_OUTPUT_CONFIGURATION_HPP