entity.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_entity_hpp
#define bempp_entity_hpp

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

#include "geometry_type.hpp"

#include <boost/utility/enable_if.hpp>
#include <dune/common/static_assert.hh>
#include <dune/grid/common/geometry.hh>
#include <memory>
#include <stdexcept>

namespace Bempp
{

class Geometry;
template<int codim> class EntityPointer;
template<int codim> class EntityIterator;
template<int codim>
class Entity
{
public:
    virtual ~Entity() {
    }

    enum {
        codimension = codim
    };

    virtual size_t level() const = 0;

    virtual const Geometry& geometry() const = 0;

    virtual GeometryType type() const = 0;
};

template<>
class Entity<0>
{
public:
    virtual ~Entity() {
    }

    enum {
        codimension = 0
    };

    virtual size_t level() const = 0;

    virtual const Geometry& geometry() const = 0;

    virtual GeometryType type() const = 0;

    // Default implementation, specialisations for potentially allowed
    // codimensions (1 to 3) follow after class declaration.
    template<int codimSub> size_t subEntityCount() const {
        return 0;
    }

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

    virtual std::auto_ptr<EntityPointer<0> > father() const = 0;

    virtual bool hasFather() const = 0;

    virtual bool isLeaf() const = 0;

    virtual bool isRegular() const = 0;

    virtual std::auto_ptr<EntityIterator<0> > sonIterator(int maxlevel) const = 0;

    virtual bool isNew() const = 0;

    virtual bool mightVanish() const = 0;

    virtual int domain() const = 0;

    // Deferred for possible later implementation:
    // * Iteration over neighbours: Dune methods ileafbegin(), ileafend(), ilevelbegin(), ilevelend()
    // * Information about the way this element has been subdivided from
    //   its father element: Dune method geometryInFather().

private:
    virtual std::auto_ptr<EntityIterator<1> > subEntityCodim1Iterator() const = 0;
    virtual std::auto_ptr<EntityIterator<2> > subEntityCodim2Iterator() const = 0;
    virtual std::auto_ptr<EntityIterator<3> > subEntityCodim3Iterator() const = 0;

    virtual size_t subEntityCodim1Count() const = 0;
    virtual size_t subEntityCodim2Count() const = 0;
    virtual size_t subEntityCodim3Count() const = 0;

};

} // namespace Bempp

#include "entity_iterator.hpp"

namespace Bempp
{

template<>
inline std::auto_ptr<EntityIterator<1> > Entity<0>::subEntityIterator<1>() const
{
    return subEntityCodim1Iterator();
}
template<>
inline std::auto_ptr<EntityIterator<2> > Entity<0>::subEntityIterator<2>() const
{
    return subEntityCodim2Iterator();
}
template<>
inline std::auto_ptr<EntityIterator<3> > Entity<0>::subEntityIterator<3>() const
{
    return subEntityCodim3Iterator();
}

template<>
inline size_t Entity<0>::subEntityCount<1>() const
{
    return subEntityCodim1Count();
}
template<>
inline size_t Entity<0>::subEntityCount<2>() const
{
    return subEntityCodim2Count();
}
template<>
inline size_t Entity<0>::subEntityCount<3>() const
{
    return subEntityCodim3Count();
}

} // namespace Bempp

#endif