variableclass.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_VARIABLECLASS_HH
#define DUMUX_VARIABLECLASS_HH
 
#include "properties.hh"
#include <dumux/common/deprecated.hh>
 
// for  parallelization
//#include <dumux/parallel/elementhandles.hh>
 
namespace Dumux
{
 
 
template<class TypeTag>
class VariableClass
{
private:
    using GridView = typename GetPropType<TypeTag, Properties::GridGeometry>::GridView;
    using SolutionTypes = GetProp<TypeTag, Properties::SolutionTypes>;
    using CellData = GetPropType<TypeTag, Properties::CellData>;
 
    enum
    {
        dim = GridView::dimension,
    };
 
    using Element = typename GridView::Traits::template Codim<0>::Entity;
    using Vertex = typename GridView::Traits::template Codim<dim>::Entity;
 
    using VertexMapper = typename SolutionTypes::VertexMapper;
    using ElementMapper = typename SolutionTypes::ElementMapper;
 
public:
    using CellDataVector = typename std::vector<CellData>;
 
private:
    const GridView gridView_;
    ElementMapper elementMapper_;
    VertexMapper vertexMapper_;
    CellDataVector cellDataVector_;
 
public:
 
    VariableClass(const GridView& gridView) :
        gridView_(gridView),
        elementMapper_(gridView, Dune::mcmgElementLayout()),
        vertexMapper_(gridView, Dune::mcmgVertexLayout())
    {}
 
 
    void initialize()
    {
        if constexpr (Deprecated::hasUpdateGridView<ElementMapper, GridView>())
            elementMapper_.update(gridView_);
        else
            Deprecated::update(elementMapper_);
 
        if constexpr (Deprecated::hasUpdateGridView<VertexMapper, GridView>())
            vertexMapper_.update(gridView_);
        else
            Deprecated::update(vertexMapper_);
 
        cellDataVector_.resize(gridView_.size(0));
    }
 
 
    void adaptVariableSize(const int size)
    {
        cellDataVector_.resize(size);
    }
 
    CellDataVector& cellDataGlobal()
    {
        return cellDataVector_;
    }
 
    const CellDataVector& cellDataGlobal() const
    {
        assert(cellDataVector_.size() == gridView_.size(0));
 
        return cellDataVector_;
    }
 
    CellData& cellData(const int idx)
    {
        assert(cellDataVector_.size() == gridView_.size(0));
 
        return cellDataVector_[idx];
    }
 
    const CellData& cellData(const int idx) const
    {
        assert(cellDataVector_.size() == gridView_.size(0));
 
        return cellDataVector_[idx];
    }
 
 
    int index(const Element& element) const
    {
        return elementMapper_.index(element);
    }
 
 
    int index(const Vertex& vertex) const
    {
        return vertexMapper_.index(vertex);
    }
 
    const GridView& gridView() const
    {
        return gridView_;
    }
 
    ElementMapper& elementMapper()
    {
        return elementMapper_;
    }
    const ElementMapper& elementMapper() const
    {
        return elementMapper_;
    }
    VertexMapper& vertexMapper()
    {
        return vertexMapper_;
    }
    const VertexMapper& vertexMapper() const
    {
        return vertexMapper_;
    }
};
}
#endif