abstract_boundary_operator.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_abstract_boundary_operator_hpp
#define bempp_abstract_boundary_operator_hpp

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

#include "assembly_options.hpp"
#include "symmetry.hpp"

#include "../common/deprecated.hpp"
#include "../common/scalar_traits.hpp"
#include "../common/shared_ptr.hpp"
#include "../fiber/quadrature_strategy.hpp"
#include "../space/space.hpp"

#include <memory>
#include <string>
#include <vector>

namespace arma
{

template <typename eT> class Mat;
}

namespace Bempp
{

class AbstractBoundaryOperatorId;
class Grid;
class GeometryFactory;
template <typename ValueType> class DiscreteBoundaryOperator;
template <typename BasisFunctionType, typename ResultType> class AbstractBoundaryOperatorSum;
template <typename BasisFunctionType, typename ResultType> class Context;
template <typename BasisFunctionType, typename ResultType> class ElementaryAbstractBoundaryOperator;
template <typename BasisFunctionType, typename ResultType> class GridFunction;
template <typename BasisFunctionType, typename ResultType> class ScaledAbstractBoundaryOperator;
template <typename BasisFunctionType_, typename ResultType_>
class AbstractBoundaryOperator
{
public:
    typedef BasisFunctionType_ BasisFunctionType;
    typedef ResultType_ ResultType;
    typedef typename ScalarTraits<ResultType>::RealType CoordinateType;
    typedef Fiber::QuadratureStrategy<BasisFunctionType, ResultType, GeometryFactory>
    QuadratureStrategy;

    AbstractBoundaryOperator(
            const shared_ptr<const Space<BasisFunctionType> >& domain,
            const shared_ptr<const Space<BasisFunctionType> >& range,
            const shared_ptr<const Space<BasisFunctionType> >& dualToRange,
            const std::string& label,
            int symmetry);

    virtual ~AbstractBoundaryOperator();

    virtual BEMPP_DEPRECATED shared_ptr<const AbstractBoundaryOperatorId> id() const;

    shared_ptr<const Space<BasisFunctionType> > domain() const;

    shared_ptr<const Space<BasisFunctionType> > range() const;

    shared_ptr<const Space<BasisFunctionType> > dualToRange() const;

    std::string label() const;

    static std::string uniqueLabel();

    int symmetry() const;

    virtual bool isLocal() const = 0;

    shared_ptr<DiscreteBoundaryOperator<ResultType_> > assembleWeakForm(
            const Context<BasisFunctionType_, ResultType_>& context) const;

protected:

    void collectDataForAssemblerConstruction(
            const AssemblyOptions& options,
            shared_ptr<Fiber::RawGridGeometry<CoordinateType> >& testRawGeometry,
            shared_ptr<Fiber::RawGridGeometry<CoordinateType> >& trialRawGeometry,
            shared_ptr<GeometryFactory>& testGeometryFactory,
            shared_ptr<GeometryFactory>& trialGeometryFactory,
            shared_ptr<std::vector<const Fiber::Shapeset<BasisFunctionType_>*> >&
                testShapesets,
            shared_ptr<std::vector<const Fiber::Shapeset<BasisFunctionType_>*> >&
                trialShapesets,
            shared_ptr<Fiber::OpenClHandler>& openClHandler,
            bool& cacheSingularIntegrals) const;

    void collectOptionsIndependentDataForAssemblerConstruction(
            shared_ptr<Fiber::RawGridGeometry<CoordinateType> >& testRawGeometry,
            shared_ptr<Fiber::RawGridGeometry<CoordinateType> >& trialRawGeometry,
            shared_ptr<GeometryFactory>& testGeometryFactory,
            shared_ptr<GeometryFactory>& trialGeometryFactory,
            shared_ptr<std::vector<const Fiber::Shapeset<BasisFunctionType_>*> >&
                testShapesets,
            shared_ptr<std::vector<const Fiber::Shapeset<BasisFunctionType_>*> >&
                trialShapesets) const;

    void collectOptionsDependentDataForAssemblerConstruction(
            const AssemblyOptions& options,
            const shared_ptr<Fiber::RawGridGeometry<CoordinateType> >& testRawGeometry,
            const shared_ptr<Fiber::RawGridGeometry<CoordinateType> >& trialRawGeometry,
            shared_ptr<Fiber::OpenClHandler>& openClHandler,
            bool& cacheSingularIntegrals) const;

    virtual shared_ptr<DiscreteBoundaryOperator<ResultType> >
    assembleWeakFormImpl(const Context<BasisFunctionType, ResultType>& context) const = 0;

private:
    shared_ptr<const Space<BasisFunctionType> > m_domain;
    shared_ptr<const Space<BasisFunctionType> > m_range;
    shared_ptr<const Space<BasisFunctionType> > m_dualToRange;
    std::string m_label;
    int m_symmetry;
};

} // namespace Bempp

#endif