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

  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 VAN_GENUCHTEN_PARAMS_HPP
#define VAN_GENUCHTEN_PARAMS_HPP

#include <cassert>

namespace Opm {
template<class TraitsT>
class VanGenuchtenParams
{
    typedef typename TraitsT::Scalar Scalar;

public:
    typedef TraitsT Traits;

    VanGenuchtenParams()
    {
#ifndef NDEBUG
        finalized_ = false;
#endif
    }

    VanGenuchtenParams(Scalar vgAlpha, Scalar vgN)
    {
        setVgAlpha(vgAlpha);
        setVgN(vgN);
        finalize();
    }

    void finalize()
    {
#ifndef NDEBUG
        finalized_ = true;
#endif
    }

    Scalar vgAlpha() const
    { assertFinalized_(); return vgAlpha_; }

    void setVgAlpha(Scalar v)
    { vgAlpha_ = v; }

    Scalar vgM() const
    { assertFinalized_(); return vgM_; }

    void setVgM(Scalar m)
    { vgM_ = m; vgN_ = 1/(1 - vgM_); }

    Scalar vgN() const
    { assertFinalized_(); return vgN_; }

    void setVgN(Scalar n)
    { vgN_ = n; vgM_ = 1 - 1/vgN_; }

private:
#ifndef NDEBUG
    void assertFinalized_() const
    { assert(finalized_); }

    bool finalized_;
#else
    void assertFinalized_() const
    { }
#endif

    Scalar vgAlpha_;
    Scalar vgM_;
    Scalar vgN_;
};
} // namespace Opm

#endif