discrete_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.

#include "bempp/common/config_trilinos.hpp"

#ifndef bempp_discrete_boundary_operator_hpp
#define bempp_discrete_boundary_operator_hpp

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

#include "transposition_mode.hpp"
#include "boost/enable_shared_from_this.hpp"

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

#ifdef WITH_TRILINOS
#include <Thyra_LinearOpDefaultBase_decl.hpp>
#endif

#include <boost/mpl/set.hpp>
#include <boost/mpl/has_key.hpp>
#include <boost/utility/enable_if.hpp>

namespace Bempp
{

template <typename ValueType>
class DiscreteBoundaryOperator :
        public boost::enable_shared_from_this<DiscreteBoundaryOperator<ValueType> >
#ifdef WITH_TRILINOS
        , public Thyra::LinearOpDefaultBase<ValueType>
#endif
{
public:
    virtual ~DiscreteBoundaryOperator() {}

#ifdef WITH_TRILINOS
#ifndef DOXYGEN
    // import the apply() member function from base class
    // before we overload it
    using Thyra::LinearOpDefaultBase<ValueType>::apply;
#else // DOXYGEN

    void apply(const Thyra::EOpTransp M_trans,
               const Thyra::MultiVectorBase<ValueType>& x_in,
               const Thyra::Ptr<Thyra::MultiVectorBase<ValueType> >& y_inout,
               const ValueType alpha,
               const ValueType beta) const;
#endif // DOXYGEN
#endif // WITH_TRILINOS

    void apply(const TranspositionMode trans,
               const arma::Mat<ValueType>& x_in,
               arma::Mat<ValueType>& y_inout,
               const ValueType alpha,
               const ValueType beta) const;

    virtual shared_ptr<const DiscreteBoundaryOperator>
    asDiscreteAcaBoundaryOperator(double eps=-1, int maximumRank=-1,
                                  bool interleave=false) const;

    virtual void dump() const;

    virtual arma::Mat<ValueType> asMatrix() const;

    virtual unsigned int rowCount() const = 0;

    virtual unsigned int columnCount() const = 0;

    virtual void addBlock(const std::vector<int>& rows,
                          const std::vector<int>& cols,
                          const ValueType alpha,
                          arma::Mat<ValueType>& block) const = 0;

#ifdef WITH_TRILINOS
protected:
    virtual void applyImpl(
            const Thyra::EOpTransp M_trans,
            const Thyra::MultiVectorBase<ValueType> &X_in,
            const Teuchos::Ptr<Thyra::MultiVectorBase<ValueType> > &Y_inout,
            const ValueType alpha,
            const ValueType beta) const;
#endif

private:
    virtual void applyBuiltInImpl(const TranspositionMode trans,
                                  const arma::Col<ValueType>& x_in,
                                  arma::Col<ValueType>& y_inout,
                                  const ValueType alpha,
                                  const ValueType beta) const = 0;
};

template <typename ValueType>
shared_ptr<const DiscreteBoundaryOperator<ValueType> > operator+(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op);

template <typename ValueType>
shared_ptr<const DiscreteBoundaryOperator<ValueType> > operator-(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op);

template <typename ValueType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > operator+(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op1,
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op2);

template <typename ValueType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > operator-(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op1,
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op2);

template <typename ValueType, typename ScalarType>
typename boost::enable_if<
    typename boost::mpl::has_key<
        boost::mpl::set<float, double, std::complex<float>, std::complex<double> >,
        ScalarType>,
    shared_ptr<DiscreteBoundaryOperator<ValueType> > >::type
operator*(
        ScalarType scalar,
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op);

template <typename ValueType, typename ScalarType>
typename boost::enable_if<
    typename boost::mpl::has_key<
        boost::mpl::set<float, double, std::complex<float>, std::complex<double> >,
        ScalarType>,
    shared_ptr<DiscreteBoundaryOperator<ValueType> > >::type
operator*(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op,
        ScalarType scalar);

template <typename ValueType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > operator*(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op1,
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op2);

template <typename ValueType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > mul(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op1,
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op2);

template <typename ValueType, typename ScalarType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > operator/(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op,
        ScalarType scalar);

template <typename ValueType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > transpose(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op);

template <typename ValueType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > conjugate(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op);

template <typename ValueType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > conjugateTranspose(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op);

template <typename ValueType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > transpose(
        TranspositionMode trans,
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op);

template <typename RealType>
shared_ptr<DiscreteBoundaryOperator<std::complex<RealType> > > complexify(
        const shared_ptr<const DiscreteBoundaryOperator<RealType> >& op);

template <typename ValueType>
shared_ptr<DiscreteBoundaryOperator<ValueType> > sum(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op1,
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op2);

} // namespace Bempp

#endif