frictionlaw.hh

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:
/*****************************************************************************
 *   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_FRICTIONLAW_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_HH
 
#include <algorithm>
#include <cmath>
 
#include <dune/common/fvector.hh>
 
namespace Dumux {
template <typename VolumeVariables >
class FrictionLaw
{
    using Scalar = typename VolumeVariables::PrimaryVariables::value_type;
public:
    virtual Dune::FieldVector<Scalar, 2> bottomShearStress(const VolumeVariables& volVars) const = 0;
 
    [[deprecated("Use bottomShearStress. Note that the unit and sign of the return value is different. Will be removed after release 3.5")]]
    virtual Dune::FieldVector<Scalar, 2> shearStress(const VolumeVariables& volVars) const
    { auto bss = bottomShearStress(volVars); bss /= -volVars.density(); return bss; }
 
    Scalar limitRoughH(const Scalar roughnessHeight, const Scalar waterDepth) const
    {
        using std::clamp;
 
        const Scalar mobilityMax = 1.0; 
 
        const Scalar minUpperH = roughnessHeight * 2.0;
        const Scalar sw = clamp(waterDepth * (1.0/minUpperH), 0.0, 1.0);
        const Scalar mobility = mobilityMax /(1.0 + (1.0-sw)*(1.0-sw));
        return roughnessHeight * (1.0 - mobility);
    }
 
    // virtual base class needs a virtual destructor
    virtual ~FrictionLaw() = default;
};
 
} // end namespace Dumux
 
#endif