constraintinfo.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:
//
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_CONSTRAINT_INFO_HH
#define DUMUX_CONSTRAINT_INFO_HH
 
#include <algorithm>
#include <array>
 
namespace Dumux {
 
template <int numEq>
class ConstraintInfo
{
public:
    ConstraintInfo()
    { reset(); }
 
    static constexpr int size()
    { return numEq; }
 
    void reset()
    {
        for (int eqIdx=0; eqIdx < numEq; ++eqIdx)
            resetEq(eqIdx);
    }
 
    void resetEq(int eqIdx)
    { isConstraint_[eqIdx] = false; }
 
    void setAll()
    {
        for (int eqIdx = 0; eqIdx < numEq; ++ eqIdx)
            set(eqIdx);
    }
 
    void set(int eqIdx)
    { isConstraint_[eqIdx] = true; }
 
    bool isConstraintEquation(int eqIdx) const
    { return isConstraint_[eqIdx]; }
 
protected:
    std::array<bool, numEq> isConstraint_;
};
 
template <int numEq>
class DirichletConstraintInfo : public ConstraintInfo<numEq>
{
    using ParentType = ConstraintInfo<numEq>;
public:
    DirichletConstraintInfo()
    { reset(); }
 
    void reset()
    {
        for (int eqIdx=0; eqIdx < numEq; ++eqIdx)
            resetEq(eqIdx);
    }
 
    void resetEq(int eqIdx)
    {
        ParentType::resetEq(eqIdx);
        eq2pvIdx_[eqIdx] = eqIdx;
        pv2eqIdx_[eqIdx] = eqIdx;
    }
 
    void setAll()
    {
        for (int eqIdx = 0; eqIdx < numEq; ++ eqIdx)
            set(eqIdx);
    }
 
    void set(int pvIdx, int eqIdx)
    {
        ParentType::set(eqIdx);
 
        // update the equation <-> primary variable mapping
        eq2pvIdx_[eqIdx] = pvIdx;
        pv2eqIdx_[pvIdx] = eqIdx;
    }
 
    void set(int pvIdx)
    { set(pvIdx, pvIdx); }
 
    int priVarToEqIndex(int pvIdx) const
    { return pv2eqIdx_[pvIdx]; }
 
    int eqToPriVarIndex(int eqIdx) const
    { return eq2pvIdx_[eqIdx]; }
 
private:
    std::array<int, numEq> eq2pvIdx_, pv2eqIdx_;
};
 
} // end namespace Dumux
 
#endif