discrete_aca_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"
#include "bempp/common/config_ahmed.hpp"

#ifdef WITH_AHMED

#ifndef bempp_discrete_aca_boundary_operator_hpp
#define bempp_discrete_aca_boundary_operator_hpp

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

#include "discrete_boundary_operator.hpp"
#include "ahmed_aux_fwd.hpp"
#include "assembly_options.hpp" // actually only ParallelizationOptions are needed
#include "index_permutation.hpp"
#include "symmetry.hpp"
#include "../fiber/scalar_traits.hpp"

#include <iostream>
#include "../common/boost_shared_array_fwd.hpp"

#ifdef WITH_TRILINOS
#include <Teuchos_RCP.hpp>
#include <Thyra_SpmdVectorSpaceBase_decl.hpp>
#endif

namespace Bempp
{

void dumpblcluster(const blcluster* bl, const std::string& indent);

// Forward declarations

template <typename ValueType> class AcaApproximateLuInverse;
template <typename ValueType> class DiscreteAcaBoundaryOperator;
// Global functions

template <typename ValueType>
shared_ptr<const DiscreteBoundaryOperator<ValueType> > acaOperatorSum(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op1,
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op2,
        double eps, int maximumRank);

template <typename ValueType>
shared_ptr<const DiscreteBoundaryOperator<ValueType> > scaledAcaOperator(
        const ValueType& multiplier,
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op);

template <typename ValueType>
shared_ptr<const DiscreteBoundaryOperator<ValueType> > scaledAcaOperator(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op,
        const ValueType& multiplier);

//template <typename ValueType>
//shared_ptr<DiscreteAcaBoundaryOperator<ValueType> > acaOperatorComposition(
//        ValueType multiplier,
//        const shared_ptr<const DiscreteAcaBoundaryOperator<ValueType> >& op1,
//        const shared_ptr<const DiscreteAcaBoundaryOperator<ValueType> >& op2,
//        double eps, int maximumRank);

template <typename ValueType>
shared_ptr<const DiscreteBoundaryOperator<ValueType> > acaOperatorApproximateLuInverse(
        const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op,
        double delta);

// class DiscreteAcaBoundaryOperator

template <typename ValueType>
class DiscreteAcaBoundaryOperator :
        public DiscreteBoundaryOperator<ValueType>
{
    friend class AcaApproximateLuInverse<ValueType>;
    friend shared_ptr<const DiscreteBoundaryOperator<ValueType> > acaOperatorSum<>(
            const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op1,
            const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op2,
            double eps, int maximumRank);

    friend shared_ptr<const DiscreteBoundaryOperator<ValueType> > scaledAcaOperator<>(
            const ValueType& multiplier,
            const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op);

    friend shared_ptr<const DiscreteBoundaryOperator<ValueType> > scaledAcaOperator<>(
            const shared_ptr<const DiscreteBoundaryOperator<ValueType> >& op,
            const ValueType& multiplier);

public:
    typedef typename Fiber::ScalarTraits<ValueType>::RealType CoordinateType;
    typedef AhmedDofWrapper<CoordinateType> AhmedDofType;
    typedef bbxbemblcluster<AhmedDofType, AhmedDofType> AhmedBemBlcluster;
    typedef mblock<typename AhmedTypeTraits<ValueType>::Type> AhmedMblock;
    typedef boost::shared_array<AhmedMblock*> AhmedMblockArray;
    // Unfortunately currently shared_array<T> cannot be converted to
    // shared_array<const T>. So we can't write
    //     typedef boost::shared_array<const AhmedMblock*> AhmedConstMblockArray;
    // and need to use this instead:
    typedef boost::shared_array<AhmedMblock*> AhmedConstMblockArray;

    DiscreteAcaBoundaryOperator(
            unsigned int rowCount, unsigned int columnCount,
            double epsUsedInAssembly,
            int maximumRankUsedInAssembly,
            int symmetry,
            const shared_ptr<const AhmedBemBlcluster>& blockCluster_,
            const AhmedMblockArray& blocks_,
            const IndexPermutation& domainPermutation_,
            const IndexPermutation& rangePermutation_,
            const ParallelizationOptions& parallelizationOptions_,
            const std::vector<AhmedConstMblockArray>& sharedBlocks_ =
                std::vector<AhmedConstMblockArray>());

    DiscreteAcaBoundaryOperator(
            unsigned int rowCount, unsigned int columnCount,
            int maximumRankUsedInAssembly,
            int symmetry,
            std::auto_ptr<const AhmedBemBlcluster> blockCluster_,
            AhmedMblockArray blocks_,
            const IndexPermutation& domainPermutation_,
            const IndexPermutation& rangePermutation_,
            const ParallelizationOptions& parallelizationOptions_,
            const std::vector<AhmedConstMblockArray>& sharedBlocks_ =
                std::vector<AhmedConstMblockArray>()) BEMPP_DEPRECATED;

    BEMPP_DEPRECATED
    DiscreteAcaBoundaryOperator(
            unsigned int rowCount, unsigned int columnCount,
            int maximumRankUsedInAssembly,
            int symmetry,
            const shared_ptr<const AhmedBemBlcluster>& blockCluster_,
            const AhmedMblockArray& blocks_,
            const IndexPermutation& domainPermutation_,
            const IndexPermutation& rangePermutation_,
            const ParallelizationOptions& parallelizationOptions_,
            const std::vector<AhmedConstMblockArray>& sharedBlocks_ =
                std::vector<AhmedConstMblockArray>());

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

    virtual unsigned int rowCount() const;
    virtual unsigned int columnCount() const;

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

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

    void makeAllMblocksDense();

    static const DiscreteAcaBoundaryOperator<ValueType>& castToAca(
            const DiscreteBoundaryOperator<ValueType>& discreteOperator);

    static shared_ptr<const DiscreteAcaBoundaryOperator<ValueType> > castToAca(
            const shared_ptr<const DiscreteBoundaryOperator<ValueType> >&
            discreteOperator);

    int maximumRank() const;

    double eps() const;

    int actualMaximumRank() const;

    int symmetry() const;

    shared_ptr<const AhmedBemBlcluster> blockCluster() const;

    AhmedMblockArray blocks() const;

    size_t blockCount() const;

    const IndexPermutation& domainPermutation() const;

    const IndexPermutation& rangePermutation() const;

    const ParallelizationOptions& parallelizationOptions() const;

    std::vector<AhmedConstMblockArray> sharedBlocks() const;

#ifdef WITH_TRILINOS
public:
    virtual Teuchos::RCP<const Thyra::VectorSpaceBase<ValueType> > domain() const;
    virtual Teuchos::RCP<const Thyra::VectorSpaceBase<ValueType> > range() const;

protected:
    virtual bool opSupportedImpl(Thyra::EOpTransp M_trans) 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;

private:
#ifdef WITH_TRILINOS
    Teuchos::RCP<const Thyra::SpmdVectorSpaceBase<ValueType> > m_domainSpace;
    Teuchos::RCP<const Thyra::SpmdVectorSpaceBase<ValueType> > m_rangeSpace;
#else
    unsigned int m_rowCount;
    unsigned int m_columnCount;
#endif
    double m_eps;
    int m_maximumRank; // used by the approximate-LU preconditioner
    int m_symmetry;

    shared_ptr<const AhmedBemBlcluster> m_blockCluster;
    AhmedMblockArray m_blocks;

    IndexPermutation m_domainPermutation;
    IndexPermutation m_rangePermutation;
    ParallelizationOptions m_parallelizationOptions;
    std::vector<AhmedConstMblockArray> m_sharedBlocks;
};

} // namespace Bempp

#endif // WITH_AHMED

#endif