fvbaseconstraints.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:
/*
  Copyright (C) 2010-2013 by Andreas Lauser

  This file is part of the Open Porous Media project (OPM).

  OPM 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 2 of the License, or
  (at your option) any later version.

  OPM 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 OPM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef EWOMS_FV_BASE_CONSTRAINTS_HH
#define EWOMS_FV_BASE_CONSTRAINTS_HH

#include <ewoms/common/propertysystem.hh>
#include <opm/material/common/Valgrind.hpp>

namespace Ewoms {
namespace Properties {
NEW_PROP_TAG(PrimaryVariables);
NEW_PROP_TAG(Scalar);
NEW_PROP_TAG(NumEq);
}

template <class TypeTag>
class FvBaseConstraints : public GET_PROP_TYPE(TypeTag, PrimaryVariables)
{
    typedef typename GET_PROP_TYPE(TypeTag, PrimaryVariables) ParentType;
    typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;

    enum { numEq = GET_PROP_VALUE(TypeTag, NumEq) };

public:
    FvBaseConstraints()
    { reset(); }


    using ParentType::operator=;

    void reset()
    {
        for (int i=0; i < numEq; ++i) {
            constraintInfo_[i].isConstraint = 0;

            eq2pvIdx_[i] = i;
            pv2eqIdx_[i] = i;
        }
    }

    bool isConstraint() const
    {
        for (int eqIdx = 0; eqIdx < numEq; ++eqIdx)
            if (constraintInfo_[eqIdx].isConstraint)
                return true;
        return false;
    }

    bool isConstraint(int eqIdx) const
    { return constraintInfo_[eqIdx].isConstraint; }

    void setAllConstraint()
    {
        for (int eqIdx = 0; eqIdx < numEq; ++ eqIdx) {
            constraintInfo_[eqIdx].isConstraint = 1;

            eq2pvIdx_[eqIdx] = eqIdx;
            pv2eqIdx_[eqIdx] = eqIdx;
        }
        //Valgrind::SetDefined(constraintInfo_[eqIdx]);
    }

    void setConstraint(int eqIdx, int pvIdx, Scalar value)
    {
        setConstraint(eqIdx, pvIdx);
        ParentType::operator[](pvIdx) = value;

        //Valgrind::SetDefined(constraintInfo_);
    }

    void setConstraint(int eqIdx, int pvIdx)
    {
        constraintInfo_[eqIdx].isConstraint = 1;

        // update the equation <-> primary variable mapping
        eq2pvIdx_[eqIdx] = pvIdx;
        pv2eqIdx_[pvIdx] = eqIdx;

        //Valgrind::SetDefined(constraintInfo_[eqIdx]);
    }

    unsigned pvToEqIndex(unsigned pvIdx) const
    { return pv2eqIdx_[pvIdx]; }

    unsigned eqToPvIndex(unsigned eqIdx) const
    { return eq2pvIdx_[eqIdx]; }

private:
    // this is a bitfield structure!
    struct __attribute__((__packed__)) {
        unsigned char isConstraint : 1;
    } constraintInfo_[numEq];

    unsigned char eq2pvIdx_[numEq];
    unsigned char pv2eqIdx_[numEq];
};

} // namespace Ewoms

#endif