brookscoreyparams.hh 2.6 KB
Newer Older
1
2
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
3
/*****************************************************************************
4
 *   See the file COPYING for full copying permissions.                      *
5
 *                                                                           *
6
 *   This program is free software: you can redistribute it and/or modify    *
7
 *   it under the terms of the GNU General Public License as published by    *
8
9
 *   the Free Software Foundation, either version 2 of the License, or       *
 *   (at your option) any later version.                                     *
10
 *                                                                           *
11
12
 *   This program is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
13
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
14
15
16
17
 *   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/>.   *
18
 *****************************************************************************/
19

20
21
22
/*!
 * \file
 *
23
24
 * \brief Specification of the material parameters
 *       for the Brooks Corey constitutive relations.
25
26
27
28
29
30
31
32
33
34
 */
#ifndef DUMUX_BROOKS_COREY_PARAMS_HH
#define DUMUX_BROOKS_COREY_PARAMS_HH

#include <dumux/common/valgrind.hh>

namespace Dumux
{

/*!
35
36
37
38
39
40
 * \brief Specification of the material parameters
 *       for the Brooks Corey constitutive relations.
 *
 *        \ingroup fluidmatrixinteractionsparams
 *
 *\see BrooksCorey
41
42
43
44
45
46
47
48
49
50
51
52
 */
template <class ScalarT>
class BrooksCoreyParams
{
public:
    typedef ScalarT Scalar;

    BrooksCoreyParams()
    {
        Valgrind::SetUndefined(*this);
    }

53
54
    BrooksCoreyParams(Scalar pe, Scalar lambda)
        : pe_(pe), lambda_(lambda)
55
56
57
58
    {
    }

    /*!
Alexander Kissinger's avatar
Alexander Kissinger committed
59
     * \brief Returns the entry pressure in \f$\mathrm{[Pa]}\f$
60
61
62
63
64
     */
    Scalar pe() const
    { return pe_; }

    /*!
Alexander Kissinger's avatar
Alexander Kissinger committed
65
     * \brief Set the entry pressure in \f$\mathrm{[Pa]}\f$]
66
67
68
69
70
71
     */
    void setPe(Scalar v)
    { pe_ = v; }


    /*!
Alexander Kissinger's avatar
Alexander Kissinger committed
72
     * \brief Returns the lambda shape parameter \f$\mathrm{[-]}\f$
73
     */
74
75
    Scalar lambda() const
    { return lambda_; }
76
77

    /*!
Alexander Kissinger's avatar
Alexander Kissinger committed
78
     * \brief Set the lambda shape parameter \f$\mathrm{[-]}\f$
79
     */
80
81
    void setLambda(Scalar v)
    { lambda_ = v; }
82
83
84

private:
    Scalar pe_;
85
    Scalar lambda_;
86
};
87
} // namespace Dumux
88
89

#endif