exponentialcubic.hh

Go to the documentation of this file.

/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program 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 3 of the License, or       *
 *   (at your option) any later version.                                     *
 *                                                                           *
 *   This program 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 this program. If not, see <http://www.gnu.org/licenses/>.    *
 *****************************************************************************/
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_TWO_P_INTERFACIAL_AREA_EXPONENTIAL_CUBIC
#define DUMUX_MATERIAL_FLUIDMATRIX_TWO_P_INTERFACIAL_AREA_EXPONENTIAL_CUBIC
 
#include <cmath>
#include <dune/common/exceptions.hh>
#include <dune/common/float_cmp.hh>
#include <dumux/common/parameters.hh>
 
namespace Dumux::FluidMatrix {
 
class InterfacialAreaExponentialCubic
{
public:
 
    template<class Scalar>
    struct Params
    {
        Params(Scalar a1 = 0, Scalar a2 = 0, Scalar a3 = 0)
        : a1_(a1), a2_(a2), a3_(a3) {}
 
        Scalar a1() const { return a1_; }
        void setA1(Scalar a1) { a1_ = a1; }
 
        Scalar a2() const { return a2_; }
        void setA2(Scalar a2) { a2_ = a2; }
 
        Scalar a3() const { return a3_; }
        void setA3(Scalar a3) { a3_ = a3; }
 
        bool operator== (const Params& p) const
        {
            return Dune::FloatCmp::eq(a1(), p.a1(), 1e-6)
                   && Dune::FloatCmp::eq(a2(), p.a2(), 1e-6)
                   && Dune::FloatCmp::eq(a3(), p.a3(), 1e-6);
        }
 
    private:
        Scalar a1_, a2_, a3_;
    };
 
    template<class Scalar = double>
    static Params<Scalar> makeParams(const std::string& paramGroup)
    {
        const auto a1 = getParamFromGroup<Scalar>(paramGroup, "A1");
        const auto a2 = getParamFromGroup<Scalar>(paramGroup, "A2");
        const auto a3 = getParamFromGroup<Scalar>(paramGroup, "A3");
        return {a1, a2, a3};
    }
 
    template<class Scalar>
    static Scalar area(const Scalar swe, const Scalar pc, const Params<Scalar>& params)
    {
        // TODO think about awn surface for relative saturation
        const Scalar a1 = params.a1();
        const Scalar a2 = params.a2();
        const Scalar a3 = params.a3();
 
        using std::exp;
        return a1 * exp( a2 * swe) + a3 * pc * pc * pc ;
    }
};
 
} // namespace Dumux::FluidMatrix
 
#endif