TpetraMatrix.h

// Copyright (C) 2014
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// First added:  2014

#ifndef __TPETRA_MATRIX_H
#define __TPETRA_MATRIX_H

#ifdef HAS_TRILINOS

#include <array>
#include <cstdint>
#include <memory>
#include <string>
#include <utility>

#include <Teuchos_GlobalMPISession.hpp>
#include <Teuchos_oblackholestream.hpp>
#include <Tpetra_CrsMatrix.hpp>
#include <Tpetra_DefaultPlatform.hpp>
#include <Tpetra_Vector.hpp>
#include <Tpetra_Version.hpp>

#include <dolfin/common/types.h>
#include "GenericMatrix.h"

namespace dolfin
{

  class GenericLinearAlgebraFactory;
  class IndexMap;
  class TensorLayout;
  class TpetraVector;


  class TpetraMatrix : public GenericMatrix
  {

  public:

    typedef Tpetra::CrsMatrix<double, int, dolfin::la_index> matrix_type;
    typedef Tpetra::CrsGraph<int, dolfin::la_index> graph_type;
    typedef Tpetra::Map<int, dolfin::la_index> map_type;

    TpetraMatrix();

    explicit TpetraMatrix(Teuchos::RCP<matrix_type> A);

    TpetraMatrix(const TpetraMatrix& A);

    virtual ~TpetraMatrix();

    //--- Implementation of the GenericTensor interface ---

    void init(const TensorLayout& tensor_layout);

    bool empty() const;

    std::size_t size(std::size_t dim) const;

    std::pair<std::int64_t, std::int64_t> local_range(std::size_t dim) const;

    // Number of non-zero entries
    std::size_t nnz() const;

    virtual void zero();

    virtual void apply(std::string mode);

    MPI_Comm mpi_comm() const;

    virtual std::string str(bool verbose) const;

    //--- Implementation of the GenericMatrix interface --

    virtual std::shared_ptr<GenericMatrix> copy() const;

    virtual void init_vector(GenericVector& z, std::size_t dim) const;

    virtual void get(double* block,
                     std::size_t m, const dolfin::la_index* rows,
                     std::size_t n, const dolfin::la_index* cols) const;

    virtual void set(const double* block,
                     std::size_t m, const dolfin::la_index* rows,
                     std::size_t n, const dolfin::la_index* cols);

    virtual void set_local(const double* block,
                           std::size_t m, const dolfin::la_index* rows,
                           std::size_t n, const dolfin::la_index* cols);

    virtual void add(const double* block,
                     std::size_t m, const dolfin::la_index* rows,
                     std::size_t n, const dolfin::la_index* cols);

    virtual void add_local(const double* block,
                           std::size_t m, const dolfin::la_index* rows,
                           std::size_t n, const dolfin::la_index* cols);

    virtual void axpy(double a, const GenericMatrix& A,
                      bool same_nonzero_pattern);

    virtual void getrow(std::size_t row,
                        std::vector<std::size_t>& columns,
                        std::vector<double>& values) const;

    virtual void setrow(std::size_t row,
                        const std::vector<std::size_t>& columns,
                        const std::vector<double>& values);

    virtual void zero(std::size_t m, const dolfin::la_index* rows);

    virtual void zero_local(std::size_t m, const dolfin::la_index* rows);

    virtual void ident(std::size_t m, const dolfin::la_index* rows);

    virtual void ident_local(std::size_t m, const dolfin::la_index* rows);

    // Matrix-vector product, y = Ax
    virtual void mult(const GenericVector& x, GenericVector& y) const;

    // Matrix-vector product, y = A^T x
    virtual void transpmult(const GenericVector& x, GenericVector& y) const;

    virtual void get_diagonal(GenericVector& x) const;

    virtual void set_diagonal(const GenericVector& x);

    virtual const TpetraMatrix& operator*= (double a);

    virtual const TpetraMatrix& operator/= (double a);

    virtual const GenericMatrix& operator= (const GenericMatrix& A);

    virtual bool is_symmetric(double tol) const;

    //--- Special functions ---

    virtual GenericLinearAlgebraFactory& factory() const;

    //--- Special TpetraFunctions ---

    double norm(std::string norm_type) const;

    const TpetraMatrix& operator= (const TpetraMatrix& A);

    Teuchos::RCP<matrix_type> mat()
    { return _matA; }

    Teuchos::RCP<const matrix_type> mat() const
    { return _matA; }

    static void graphdump(const Teuchos::RCP<const graph_type> graph);

  private:

    // The matrix
    Teuchos::RCP<matrix_type> _matA;

    // Row and Column maps to allow local indexing of off-process
    // entries needed in add_local() and set_local()
    std::array<std::shared_ptr<const IndexMap>, 2> index_map;

  };

}

#endif

#endif