ParameterCacheBase.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) 2011-2013 by Andreas Lauser
  Copyright (C) 2012 by Bernd Flemisch

  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_PARAMETER_CACHE_BASE_HPP
#define OPM_PARAMETER_CACHE_BASE_HPP

namespace Opm {

template <class Implementation>
class ParameterCacheBase
{
public:
    enum ExceptQuantities {
        None = 0,

        Temperature = 1,

        Pressure = 2,

        Composition = 4
    };

    ParameterCacheBase()
    {}

    template <class FluidState>
    void updateAll(const FluidState &fluidState, int /*exceptQuantities*/ = None)
    {
        for (unsigned phaseIdx = 0; phaseIdx < FluidState::numPhases; ++phaseIdx)
            asImp_().updatePhase(fluidState, phaseIdx);
    }

    template <class FluidState>
    void updateAllPressures(const FluidState &fluidState)
    { asImp_().updateAll(fluidState, Temperature | Composition); }

    template <class FluidState>
    void updateAllTemperatures(const FluidState &fluidState)
    {
        for (unsigned phaseIdx = 0; phaseIdx < FluidState::numPhases; ++phaseIdx)
            asImp_().updatePhase(fluidState, phaseIdx);
    }


    template <class FluidState>
    void updatePhase(const FluidState& /*fluidState*/, unsigned /*phaseIdx*/, int /*exceptQuantities*/ = None)
    {}

    template <class FluidState>
    void updateTemperature(const FluidState &fluidState, unsigned phaseIdx)
    {
        asImp_().updatePhase(fluidState, phaseIdx);
    }

    template <class FluidState>
    void updatePressure(const FluidState &fluidState, unsigned phaseIdx)
    {
        asImp_().updatePhase(fluidState, phaseIdx);
    }

    template <class FluidState>
    void updateComposition(const FluidState &fluidState, unsigned phaseIdx)
    {
        asImp_().updatePhase(fluidState, phaseIdx, /*except=*/Temperature | Pressure);
    }

    template <class FluidState>
    void updateSingleMoleFraction(const FluidState &fluidState,
                                  unsigned phaseIdx,
                                  unsigned /*compIdx*/)
    {
        asImp_().updateComposition(fluidState, phaseIdx);
    }

private:
    Implementation &asImp_()
    { return *static_cast<Implementation*>(this); }
};

} // namespace Opm

#endif