FluidStateSaturationModules.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

  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_FLUID_STATE_SATURATION_MODULES_HPP
#define OPM_FLUID_STATE_SATURATION_MODULES_HPP

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

#include <opm/material/common/MathToolbox.hpp>
#include <opm/material/common/Valgrind.hpp>

#include <algorithm>

namespace Opm {

template <class Scalar,
          int numPhases,
          class Implementation>
class FluidStateExplicitSaturationModule
{
public:
    FluidStateExplicitSaturationModule()
    { Valgrind::SetUndefined(saturation_); }

    const Scalar& saturation(unsigned phaseIdx) const
    { return saturation_[phaseIdx]; }

    void setSaturation(unsigned phaseIdx, const Scalar& value)
    { saturation_[phaseIdx] = value; }

    template <class FluidState>
    void assign(const FluidState& fs)
    {
        typedef typename FluidState::Scalar FsScalar;
        typedef Opm::MathToolbox<FsScalar> FsToolbox;
        for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
            saturation_[phaseIdx] = FsToolbox::template toLhs<Scalar>(fs.saturation(phaseIdx));
        }
    }

    void checkDefined() const
    {
        Valgrind::CheckDefined(saturation_);
    }

protected:
    Scalar saturation_[numPhases];
};

template <class Scalar>
class FluidStateNullSaturationModule
{
public:
    FluidStateNullSaturationModule()
    { }

    const Scalar& saturation(int /* phaseIdx */) const
    { OPM_THROW(std::runtime_error, "Saturation is not provided by this fluid state"); }

    template <class FluidState>
    void assign(const FluidState& /* fs */)
    { }

    void checkDefined() const
    { }
};

} // namespace Opm

#endif