components/base.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_COMPONENT_BASE_HH
#define DUMUX_COMPONENT_BASE_HH
 
#include <string>
 
#include <dune/common/exceptions.hh>
#include <dune/common/stdstreams.hh>
#include <dune/common/exceptions.hh>
#include <dumux/common/typetraits/typetraits.hh>
 
namespace Dumux {
namespace Components {
 
template <class Component>
struct IsAqueous : public std::false_type {};
 
template <class ScalarType, class Component>
class Base
{
public:
 
    using Scalar = ScalarType;
 
    static constexpr bool isTabulated = false;
 
    static void init(Scalar tempMin, Scalar tempMax, unsigned nTemp,
                     Scalar pressMin, Scalar pressMax, unsigned nPress)
    {   Dune::dwarn << "No init routine defined - make sure that this is not necessary!" << std::endl; }
 
    template<class C = Component>
    static std::string name()
    {
        static_assert(AlwaysFalse<C>::value, "Mandatory function not implemented: name()");
        DUNE_THROW(Dune::NotImplemented, "name()");
    }
 
    template<class C = Component>
    static constexpr Scalar molarMass()
    {
        static_assert(AlwaysFalse<C>::value, "Mandatory function not implemented: molarMass()");
        return 0; // iso c++ requires a return statement for constexpr functions
    }
 
    template<class C = Component>
    static constexpr Scalar criticalTemperature()
    {
        static_assert(AlwaysFalse<C>::value, "Mandatory function not implemented: criticalTemperature()");
        return 0; // iso c++ requires a return statement for constexpr functions
    }
 
    template<class C = Component>
    static constexpr Scalar criticalPressure()
    {
        static_assert(AlwaysFalse<C>::value, "Mandatory function not implemented: criticalPressure()");
        return 0; // iso c++ requires a return statement for constexpr functions
    }
 
    template<class C = Component>
    static constexpr Scalar tripleTemperature()
    {
        static_assert(AlwaysFalse<C>::value, "Mandatory function not implemented: tripleTemperature()");
        return 0; // iso c++ requires a return statement for constexpr functions
    }
 
    template<class C = Component>
    static constexpr Scalar triplePressure()
    {
        static_assert(AlwaysFalse<C>::value, "Mandatory function not implemented: triplePressure()");
        return 0; // iso c++ requires a return statement for constexpr functions
    }
 
    template<class C = Component>
    static Scalar vaporPressure(Scalar t)
    {
        static_assert(AlwaysFalse<C>::value, "Mandatory function not implemented: vaporPressure(t)");
        DUNE_THROW(Dune::NotImplemented, "vaporPressure(t)");
    }
 
};
 
} // end namespace Components
} // end namespace Dumux
 
#endif