baseauxiliarymodule.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) 2014 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_BASE_AUXILIARY_MODULE_HH
#define EWOMS_BASE_AUXILIARY_MODULE_HH

#include <ewoms/common/propertysystem.hh>

#include <ewoms/disc/common/fvbaseproperties.hh>

#include <set>
#include <vector>

namespace Ewoms {
namespace Properties {
NEW_TYPE_TAG(AuxModule);

// declare the properties required by the for the ecl grid manager
NEW_PROP_TAG(Grid);
NEW_PROP_TAG(GridView);
NEW_PROP_TAG(Scalar);
NEW_PROP_TAG(DofMapper);
NEW_PROP_TAG(GlobalEqVector);
NEW_PROP_TAG(JacobianMatrix);
} // namespace Properties

template <class TypeTag>
class BaseAuxiliaryModule
{
    typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
    typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;
    typedef typename GET_PROP_TYPE(TypeTag, GlobalEqVector) GlobalEqVector;
    typedef typename GET_PROP_TYPE(TypeTag, JacobianMatrix) JacobianMatrix;

protected:
    typedef std::set<int> NeighborSet;

public:
    virtual int numDofs() const = 0;

    void setDofOffset(int value)
    { dofOffset_ = value; }

    int dofOffset()
    { return dofOffset_; }

    int localToGlobalDof(int localDofIdx) const
    {
        assert(0 <= localDofIdx);
        assert(localDofIdx < numDofs());
        return dofOffset_ + localDofIdx;
    }

    virtual void addNeighbors(std::vector<NeighborSet>& neighbors) const = 0;

    virtual void applyInitial() = 0;

    virtual void linearize(JacobianMatrix& matrix, GlobalEqVector& residual) = 0;

private:
    int dofOffset_;
};

} // namespace Ewoms

#endif