method.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program 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.                                     *
 *                                                                           *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
#ifndef DUMUX_DISCRETIZATION_METHOD_HH
#define DUMUX_DISCRETIZATION_METHOD_HH
 
#include <ostream>
#include <string>
 
#include <dumux/common/tag.hh>
 
namespace Dumux {
 
enum class DiscretizationMethod
{
    none, box, cctpfa, ccmpfa, staggered, fem, fcstaggered
};
 
 
namespace DiscretizationMethods {
 
struct CCTpfa : public Utility::Tag<CCTpfa> {
    static std::string name() { return "cctpfa"; }
 
    //conversion operator
    [[deprecated("Conversion to enum is deprecated. Will be removed after 3.5. Use tags.")]]
    constexpr operator DiscretizationMethod() const
    {
        return DiscretizationMethod::cctpfa;
    }
};
 
 
struct CCMpfa : public Utility::Tag<CCMpfa> {
    static std::string name() { return "ccmpfa"; }
 
    //conversion operator
    [[deprecated("Conversion to enum is deprecated. Will be removed after 3.5. Use tags.")]]
    constexpr operator DiscretizationMethod() const
    {
        return DiscretizationMethod::ccmpfa;
    }
};
 
 
struct Box : public Utility::Tag<Box> {
    static std::string name() { return "box"; }
 
    //conversion operator
    [[deprecated("Conversion to enum is deprecated. Will be removed after 3.5. Use tags.")]]
    constexpr operator DiscretizationMethod() const
    {
        return DiscretizationMethod::box;
    }
};
 
 
 
struct Staggered : public Utility::Tag<Staggered> {
    static std::string name() { return "staggered"; }
 
    //conversion operator
    [[deprecated("Conversion to enum is deprecated. Will be removed after 3.5. Use tags.")]]
    constexpr operator DiscretizationMethod() const
    {
        return DiscretizationMethod::staggered;
    }
};
 
 
 
struct FEM : public Utility::Tag<FEM> {
    static std::string name() { return "fem"; }
 
    //conversion operator
    [[deprecated("Conversion to enum is deprecated. Will be removed after 3.5. Use tags.")]]
    constexpr operator DiscretizationMethod() const
    {
        return DiscretizationMethod::fem;
    }
};
 
 
 
struct FCStaggered : public Utility::Tag<FCStaggered> {
    static std::string name() { return "fcstaggered"; }
 
    //conversion operator
    [[deprecated("Conversion to enum is deprecated. Will be removed after 3.5. Use tags.")]]
    constexpr operator DiscretizationMethod() const
    {
        return DiscretizationMethod::fcstaggered;
    }
};
 
 
 
struct None : public Utility::Tag<None> {
    static std::string name() { return "none"; }
 
    //conversion operator
    [[deprecated("Conversion to enum is deprecated. Will be removed after 3.5. Use tags.")]]
    constexpr operator DiscretizationMethod() const
    {
        return DiscretizationMethod::none;
    }
};
 
 
inline constexpr CCTpfa cctpfa{};
inline constexpr CCMpfa ccmpfa{};
inline constexpr Box box{};
inline constexpr Staggered staggered{};
inline constexpr FEM fem{};
inline constexpr FCStaggered fcstaggered{};
inline constexpr None none{};
 
} // end namespace DiscretizationMethods
 
[[deprecated("Use discretization tags and their name attribute. Will be removed after 3.5")]]
inline std::string toString(DiscretizationMethod m)
{
    switch (m)
    {
        case DiscretizationMethod::box: return "box";
        case DiscretizationMethod::cctpfa: return "cctpfa";
        case DiscretizationMethod::ccmpfa: return "ccmpfa";
        case DiscretizationMethod::fcstaggered: return "fcstaggered";
        case DiscretizationMethod::fem: return "fem";
        case DiscretizationMethod::staggered: return "staggered";
        default: return "none";
    }
}
 
[[deprecated("Use discretization tags which also support operator <<. Will be removed after 3.5")]]
inline std::ostream& operator<<(std::ostream& stream, DiscretizationMethod m)
{
    // get rid of deprecation warning in the transition period
    const auto toStringImpl = [](DiscretizationMethod m){
        switch (m)
        {
            case DiscretizationMethod::box: return "box";
            case DiscretizationMethod::cctpfa: return "cctpfa";
            case DiscretizationMethod::ccmpfa: return "ccmpfa";
            case DiscretizationMethod::fcstaggered: return "fcstaggered";
            case DiscretizationMethod::fem: return "fem";
            case DiscretizationMethod::staggered: return "staggered";
            default: return "none";
        }
    };
    stream << toStringImpl(m); return stream;
}
 
} // end namespace Dumux
 
#endif