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:
/*
  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/>.
 
  Consult the COPYING file in the top-level source directory of this
  module for the precise wording of the license and the list of
  copyright holders.
*/
#ifndef OPM_BASE_FLUID_SYSTEM_HPP
#define OPM_BASE_FLUID_SYSTEM_HPP
 
#include <stdexcept>
 
#include "NullParameterCache.hpp"
 
#include <dune/common/classname.hh>
 
namespace Opm {
 
template <class ScalarT, class Implementation>
class BaseFluidSystem
{
public:
    typedef ScalarT Scalar;
 
    template <class Evaluation>
    struct ParameterCache {
        ParameterCache() = delete; // derived fluid systems must specify this class!
    };
 
    static const int numComponents = -1000;
 
    static const int numPhases = -2000;
 
    static char* phaseName(unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"' does not provide a phaseName() method!");
    }
 
    static bool isLiquid(unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"' does not provide a isLiquid() method!");
    }
 
    static bool isIdealMixture(unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"' does not provide a isIdealMixture() method!");
    }
 
    static bool isCompressible(unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"' does not provide a isCompressible() method!");
    }
 
    static bool isIdealGas(unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"' does not provide a isIdealGas() method!");
    }
 
    static const char* componentName(unsigned /*compIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"' does not provide a componentName() method!");
    }
 
    static Scalar molarMass(unsigned /*compIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"' does not provide a molarMass() method!");
    }
 
    static Scalar acentricFactor(unsigned /*compIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"' does not provide a acentricFactor() method!");
    }
 
    static void init()
    { }
 
    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
    static LhsEval density(const FluidState& /*fluidState*/,
                           const ParamCache& /*paramCache*/,
                           unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"' does not provide a density() method!");
    }
 
    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
    static LhsEval fugacityCoefficient(const FluidState& /*fluidState*/,
                                       ParamCache& /*paramCache*/,
                                       unsigned /*phaseIdx*/,
                                       unsigned /*compIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"'  does not provide a fugacityCoefficient() method!");
    }
 
    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
    static LhsEval viscosity(const FluidState& /*fluidState*/,
                             ParamCache& /*paramCache*/,
                             unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"'  does not provide a viscosity() method!");
    }
 
    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
    static LhsEval diffusionCoefficient(const FluidState& /*fluidState*/,
                                        ParamCache& /*paramCache*/,
                                        unsigned /*phaseIdx*/,
                                        unsigned /*compIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"'  does not provide a diffusionCoefficient() method!");
    }
 
    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
    static LhsEval enthalpy(const FluidState& /*fluidState*/,
                            ParamCache& /*paramCache*/,
                            unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"'  does not provide an enthalpy() method!");
    }
 
    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
    static LhsEval thermalConductivity(const FluidState& /*fluidState*/,
                                       ParamCache& /*paramCache*/,
                                       unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"'  does not provide a thermalConductivity() method!");
    }
 
    template <class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
    static LhsEval heatCapacity(const FluidState& /*fluidState*/,
                                ParamCache& /*paramCache*/,
                                unsigned /*phaseIdx*/)
    {
        throw std::runtime_error("Not implemented: The fluid system '"+Dune::className<Implementation>()+"'  does not provide a heatCapacity() method!");
    }
 
 
    static unsigned phaseIsActive(unsigned /*phaseIdx*/)
    {
        return true;
    }
};
 
} // namespace Opm
 
#endif