grid_view.hpp

// Copyright (C) 2011-2012 by the BEM++ Authors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#ifndef bempp_grid_view_hpp
#define bempp_grid_view_hpp

#include "../common/common.hpp"

#include "geometry_type.hpp"
#include "entity_iterator.hpp"

#include "../common/armadillo_fwd.hpp"
#include <boost/utility/enable_if.hpp>
#include <dune/grid/io/file/vtk/vtkwriter.hh>
#include <memory>
#include <stdexcept>

namespace Bempp
{

template<int codim> class Entity;
template<int codim> class EntityCache;
class IndexSet;
class Mapper;
class ReverseElementMapper;
class VtkWriter;
class GridView
{
public:
    virtual ~GridView() {
    }

    virtual int dim() const = 0;

    virtual int dimWorld() const = 0;

    virtual const IndexSet& indexSet() const = 0;

    virtual const Mapper& elementMapper() const = 0;

    virtual size_t entityCount(int codim) const = 0;

    virtual size_t entityCount(const GeometryType &type) const = 0;

    virtual bool containsEntity(const Entity<0>& e) const = 0;
    virtual bool containsEntity(const Entity<1>& e) const = 0;
    virtual bool containsEntity(const Entity<2>& e) const = 0;
    virtual bool containsEntity(const Entity<3>& e) const = 0;

    // Default implementation; specialisations for potentially allowed codimensions follow
    // after class declaration.
    template<int codim>
    std::auto_ptr<EntityIterator<codim> > entityIterator() const {
        throw std::logic_error("GridView::entityIterator(): invalid entity codimension");
    }

    void getRawElementData(arma::Mat<float>& vertices,
                           arma::Mat<int>& elementCorners,
                           arma::Mat<char>& auxData ) const;
    void getRawElementData(arma::Mat<double>& vertices,
                           arma::Mat<int>& elementCorners,
                           arma::Mat<char>& auxData ) const;


    void getRawElementData(arma::Mat<double>& vertices,
                           arma::Mat<int>& elementCorners,
                           arma::Mat<char>& auxData,
                           std::vector<int>& domainIndices) const;
    void getRawElementData(arma::Mat<float>& vertices,
                           arma::Mat<int>& elementCorners,
                           arma::Mat<char>& auxData,
                           std::vector<int>& domainIndices) const;

    virtual const ReverseElementMapper& reverseElementMapper() const = 0;

    virtual std::auto_ptr<VtkWriter> vtkWriter(Dune::VTK::DataMode dm=Dune::VTK::conforming) const = 0;

    // Deferred for later implementation:
    // * Iteration over neighbours: Dune methods ibegin() and iend().

private:
    virtual void getRawElementDataDoubleImpl(
            arma::Mat<double>& vertices,
            arma::Mat<int>& elementCorners,
            arma::Mat<char>& auxData,
            std::vector<int>* domainIndices) const = 0;
    virtual void getRawElementDataFloatImpl(
            arma::Mat<float>& vertices,
            arma::Mat<int>& elementCorners,
            arma::Mat<char>& auxData,
            std::vector<int>* domainIndices) const = 0;

    virtual std::auto_ptr<EntityIterator<0> > entityCodim0Iterator() const = 0;
    virtual std::auto_ptr<EntityIterator<1> > entityCodim1Iterator() const = 0;
    virtual std::auto_ptr<EntityIterator<2> > entityCodim2Iterator() const = 0;
    virtual std::auto_ptr<EntityIterator<3> > entityCodim3Iterator() const = 0;
};

inline void GridView::getRawElementData(arma::Mat<double>& vertices,
                                        arma::Mat<int>& elementCorners,
                                        arma::Mat<char>& auxData) const
{
    getRawElementDataDoubleImpl(vertices, elementCorners, auxData, 0);
}

inline void GridView::getRawElementData(arma::Mat<float>& vertices,
                                        arma::Mat<int>& elementCorners,
                                        arma::Mat<char>& auxData) const
{
    getRawElementDataFloatImpl(vertices, elementCorners, auxData, 0);
}

inline void GridView::getRawElementData(arma::Mat<double>& vertices,
                                        arma::Mat<int>& elementCorners,
                                        arma::Mat<char>& auxData,
                                        std::vector<int>& domainIndices) const
{
    getRawElementDataDoubleImpl(vertices, elementCorners, auxData,
                                &domainIndices);
}

inline void GridView::getRawElementData(arma::Mat<float>& vertices,
                                        arma::Mat<int>& elementCorners,
                                        arma::Mat<char>& auxData,
                                        std::vector<int>& domainIndices) const
{
    getRawElementDataFloatImpl(vertices, elementCorners, auxData,
                               &domainIndices);
}


template<>
inline std::auto_ptr<EntityIterator<0> > GridView::entityIterator<0>() const
{
    return entityCodim0Iterator();
}
template<>
inline std::auto_ptr<EntityIterator<1> > GridView::entityIterator<1>() const
{
    return entityCodim1Iterator();
}
template<>
inline std::auto_ptr<EntityIterator<2> > GridView::entityIterator<2>() const
{
    return entityCodim2Iterator();
}
template<>
inline std::auto_ptr<EntityIterator<3> > GridView::entityIterator<3>() const
{
    return entityCodim3Iterator() ;
}

} // namespace Bempp

#endif