discretization/staggered/freeflow/boundarytypes.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 STAGGERED_FREEFLOW_BOUNDARY_TYPES_HH
#define STAGGERED_FREEFLOW_BOUNDARY_TYPES_HH
 
#include <dumux/common/boundarytypes.hh>
#include <dumux/common/typetraits/typetraits.hh>
 
namespace Dumux {
 
template <int numEq>
class StaggeredFreeFlowBoundaryTypes : public Dumux::BoundaryTypes<numEq>
{
    using ParentType = Dumux::BoundaryTypes<numEq>;
 
public:
    StaggeredFreeFlowBoundaryTypes()
    {
        for (int eqIdx=0; eqIdx < numEq; ++eqIdx)
            resetEq(eqIdx);
    }
 
    void resetEq(int eqIdx)
    {
        ParentType::resetEq(eqIdx);
 
        boundaryInfo_[eqIdx].visited = false;
        boundaryInfo_[eqIdx].isSymmetry = false;
        boundaryInfo_[eqIdx].isBeaversJoseph = false;
    }
 
    void setAllSymmetry()
    {
        for (int eqIdx=0; eqIdx < numEq; ++eqIdx)
        {
            resetEq(eqIdx);
            boundaryInfo_[eqIdx].visited = true;
            boundaryInfo_[eqIdx].isSymmetry = true;
        }
    }
 
    bool isSymmetry() const
    { return boundaryInfo_[0].isSymmetry; }
 
    template<class T = void>
    void setAllDirichlet()
    {
        static_assert(AlwaysFalse<T>::value, "Setting all boundary types to Dirichlet not permitted!");
    }
 
    template<class T = void>
    void setAllNeumann()
    {
        static_assert(AlwaysFalse<T>::value, "Setting all boundary types to Neumann not permitted!");
    }
 
    [[deprecated("Use setBeaversJoseph instead. Will be removed after 3.2")]]
    void setBJS(int eqIdx)
    { setBeaversJoseph(eqIdx); }
 
    void setBeaversJoseph(unsigned eqIdx)
    {
        resetEq(eqIdx);
        boundaryInfo_[eqIdx].visited = true;
        boundaryInfo_[eqIdx].isBeaversJoseph = true;
    }
 
    [[deprecated("Use isBeaversJoseph instead. Will be removed after 3.2")]]
    bool isBJS(unsigned eqIdx) const
    { return isBeaversJoseph(eqIdx); }
 
    bool isBeaversJoseph(unsigned eqIdx) const
    { return boundaryInfo_[eqIdx].isBeaversJoseph; }
 
    [[deprecated("Use hasBeaversJoseph instead. Will be removed after 3.2")]]
    bool hasBJS() const
    { return hasBeaversJoseph(); }
 
    bool hasBeaversJoseph() const
    {
        for (int i = 0; i < numEq; ++i)
            if (boundaryInfo_[i].isBeaversJoseph)
                return true;
        return false;
    }
 
protected:
    struct StaggeredFreeFlowBoundaryInfo
    {
        bool visited;
        bool isSymmetry;
        bool isBeaversJoseph;
    };
 
    std::array<StaggeredFreeFlowBoundaryInfo, numEq> boundaryInfo_;
};
 
} // end namespace Dumux
 
#endif