Ifpack2_BandedContainer_decl.hpp

Go to the documentation of this file.

/*@HEADER
// ***********************************************************************
//
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/
#ifndef IFPACK2_BANDEDCONTAINER_DECL_HPP
#define IFPACK2_BANDEDCONTAINER_DECL_HPP


#include "Ifpack2_Container.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_RowMatrix.hpp"
#include "Teuchos_SerialBandDenseMatrix.hpp"

namespace Ifpack2 {


template<class MatrixType, class LocalScalarType>
class BandedContainer
: public ContainerImpl<MatrixType, LocalScalarType>
{

private:
  using matrix_type = MatrixType;
  using LSC = LocalScalarType;

  using typename Container<MatrixType>::SC;
  using typename Container<MatrixType>::LO;
  using typename Container<MatrixType>::GO;
  using typename Container<MatrixType>::NO;

  using typename Container<MatrixType>::ISC;
  using typename ContainerImpl<MatrixType, LSC>::LISC;

  using typename Container<MatrixType>::mv_type;
  using typename Container<MatrixType>::map_type;
  using local_mv_type = Tpetra::MultiVector<LSC, LO, GO, NO>;
  using typename Container<MatrixType>::vector_type;
  using typename Container<MatrixType>::import_type;

  using typename Container<MatrixType>::HostView;
  using typename ContainerImpl<MatrixType, LSC>::HostSubviewLocal;
  using typename ContainerImpl<MatrixType, LSC>::ConstHostSubviewLocal;
  using typename ContainerImpl<MatrixType,LSC>::block_crs_matrix_type;
  using HostViewLocal = typename local_mv_type::dual_view_type::t_host;

  static_assert(std::is_same<MatrixType,
                  Tpetra::RowMatrix<SC, LO, GO, NO> >::value,
                "Ifpack2::BandedContainer: Please use MatrixType = Tpetra::RowMatrix.");

  using typename Container<MatrixType>::row_matrix_type;

public:


  BandedContainer (const Teuchos::RCP<const row_matrix_type>& matrix,
                   const Teuchos::Array<Teuchos::Array<LO> >& partitions,
                   const Teuchos::RCP<const import_type>&,
                   bool pointIndexed);

  BandedContainer (const BandedContainer<MatrixType, LSC>& rhs) = delete;

  virtual ~BandedContainer ();



  virtual void setParameters (const Teuchos::ParameterList& List) override;



  virtual void initialize () override;

  virtual void compute () override;

  void computeBandwidth();

  void clearBlocks() override;



  virtual std::ostream& print (std::ostream& os) const override;



  virtual std::string description () const override;

  virtual void
  describe (Teuchos::FancyOStream &out,
            const Teuchos::EVerbosityLevel verbLevel =
            Teuchos::Describable::verbLevel_default) const override;


  static std::string getName();

private:

  void extract() override;

  void factor ();

  void
  solveBlock(ConstHostSubviewLocal X,
             HostSubviewLocal Y,
             int blockIndex,
             Teuchos::ETransp mode,
             const LSC alpha,
             const LSC beta) const override;

  std::vector<Teuchos::SerialBandDenseMatrix<int, LSC> > diagBlocks_;

  Teuchos::Array<int> ipiv_;

  Teuchos::Array<LO> kl_; //< number of subdiagonals
  Teuchos::Array<LO> ku_; //< number of superdiagonals

  Teuchos::Array<LSC> scalars_;

  Teuchos::Array<LO> scalarOffsets_;
};

} // namespace Ifpack2

#endif // IFPACK2_BANDEDCONTAINER_DECL_HPP