BaseFluidSystem.hpp

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:
/*
  Copyright (C) 2009-2013 by Andreas Lauser
  Copyright (C) 2012 by Philipp Nuske
  Copyright (C) 2012 by Klaus Mosthaf

  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 2 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_BASE_FLUID_SYSTEM_HPP
#define OPM_BASE_FLUID_SYSTEM_HPP

#include "NullParameterCache.hpp"

#include <opm/common/Exceptions.hpp>
#include <opm/common/ErrorMacros.hpp>
#include <opm/material/common/ClassName.hpp>

namespace Opm {

template <class Scalar, class Implementation>
class BaseFluidSystem
{
public:
    typedef NullParameterCache ParameterCache;

    static const int numComponents = -1000;

    static const int numPhases = -2000;

    static char *phaseName(unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error,
                  "Not implemented: The fluid system '" << Opm::className<Implementation>() << "' does not provide a phaseName() method!");
    }

    static bool isLiquid(unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error,
                  "Not implemented: The fluid system '" << Opm::className<Implementation>() << "' does not provide a isLiquid() method!");
    }

    static bool isIdealMixture(unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error,
                  "Not implemented: The fluid system '" << Opm::className<Implementation>() << "' does not provide a isIdealMixture() method!");
    }

    static bool isCompressible(unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error,
                  "Not implemented: The fluid system '" << Opm::className<Implementation>() << "' does not provide a isCompressible() method!");
    }

    static bool isIdealGas(unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error,
                  "Not implemented: The fluid system '" << Opm::className<Implementation>() << "' does not provide a isIdealGas() method!");
    }

    static const char *componentName(unsigned /*compIdx*/)
    {
        OPM_THROW(std::runtime_error,
                  "Not implemented: The fluid system '" << Opm::className<Implementation>() << "' does not provide a componentName() method!");
    }

    static Scalar molarMass(unsigned /*compIdx*/)
    {
        OPM_THROW(std::runtime_error,
                  "Not implemented: The fluid system '" << Opm::className<Implementation>() << "' does not provide a molarMass() method!");
    }

    static void init()
    { }

    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParameterCache = NullParameterCache>
    static LhsEval density(const FluidState &/*fluidState*/,
                           const ParameterCache &/*paramCache*/,
                           unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error,
                  "Not implemented: The fluid system '" << Opm::className<Implementation>() << "' does not provide a density() method!");
    }

    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParameterCache = NullParameterCache>
    static LhsEval fugacityCoefficient(const FluidState &/*fluidState*/,
                                       const ParameterCache &/*paramCache*/,
                                       unsigned /*phaseIdx*/,
                                       unsigned /*compIdx*/)
    {
        OPM_THROW(std::runtime_error, "Not implemented: The fluid system '" << Opm::className<Implementation>() << "'  does not provide a fugacityCoefficient() method!");
    }

    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParameterCache = NullParameterCache>
    static LhsEval viscosity(const FluidState &/*fluidState*/,
                             const ParameterCache &/*paramCache*/,
                             unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error, "Not implemented: The fluid system '" << Opm::className<Implementation>() << "'  does not provide a viscosity() method!");
    }

    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParameterCache = NullParameterCache>
    static LhsEval diffusionCoefficient(const FluidState &/*fluidState*/,
                                        const ParameterCache &/*paramCache*/,
                                        unsigned /*phaseIdx*/,
                                        unsigned /*compIdx*/)
    {
        OPM_THROW(std::runtime_error, "Not implemented: The fluid system '" << Opm::className<Implementation>() << "'  does not provide a diffusionCoefficient() method!");
    }

    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParameterCache = NullParameterCache>
    static LhsEval enthalpy(const FluidState &/*fluidState*/,
                            const ParameterCache &/*paramCache*/,
                            unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error, "Not implemented: The fluid system '" << Opm::className<Implementation>() << "'  does not provide an enthalpy() method!");
    }

    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParameterCache = NullParameterCache>
    static LhsEval thermalConductivity(const FluidState &/*fluidState*/,
                                       const ParameterCache &/*paramCache*/,
                                       unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error, "Not implemented: The fluid system '" << Opm::className<Implementation>() << "'  does not provide a thermalConductivity() method!");
    }

    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParameterCache = NullParameterCache>
    static LhsEval heatCapacity(const FluidState &/*fluidState*/,
                                const ParameterCache &/*paramCache*/,
                                unsigned /*phaseIdx*/)
    {
        OPM_THROW(std::runtime_error, "Not implemented: The fluid system '" << Opm::className<Implementation>() << "'  does not provide a heatCapacity() method!");
    }
};

} // namespace Opm

#endif