TpetraVector.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/>.
//

#ifndef __TPETRA_VECTOR_H
#define __TPETRA_VECTOR_H

#ifdef HAS_TRILINOS

#include <cstdint>
#include <map>
#include <memory>
#include <string>
#include <unordered_map>
#include <utility>

#include <Teuchos_GlobalMPISession.hpp>
#include <Teuchos_oblackholestream.hpp>
#include <Tpetra_DefaultPlatform.hpp>
#include <Tpetra_MultiVector.hpp>
#include <Tpetra_Version.hpp>

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

namespace dolfin
{

  template<typename T> class Array;


  class TpetraVector : public GenericVector
  {
  public:

    typedef Tpetra::MultiVector<>::node_type node_type;
    typedef Tpetra::Map<int, dolfin::la_index, node_type> map_type;
    typedef Tpetra::MultiVector<double, int, dolfin::la_index, node_type>
    vector_type;

    TpetraVector(MPI_Comm comm=MPI_COMM_WORLD);

    TpetraVector(MPI_Comm comm, std::size_t N);

    TpetraVector(const TpetraVector& x);

    //explicit TpetraVector(Teuchos::RCP<vector_type> x);

    virtual ~TpetraVector();

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

    virtual void zero();

    virtual void apply(std::string mode);

    virtual MPI_Comm mpi_comm() const;

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

    //--- Implementation of the GenericVector interface ---

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

    virtual void init(std::size_t N);

    virtual void init(std::pair<std::size_t, std::size_t> range);

    virtual void init(std::pair<std::size_t, std::size_t> range,
                      const std::vector<std::size_t>& local_to_global_map,
                      const std::vector<la_index>& ghost_indices);

    // Bring init function from GenericVector into scope
    using GenericVector::init;

    virtual bool empty() const;

    virtual std::size_t size() const;

    virtual std::size_t local_size() const;

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

    virtual bool owns_index(std::size_t i) const;

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


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

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

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

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

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

    virtual void get_local(std::vector<double>& values) const;

    virtual void set_local(const std::vector<double>& values);

    virtual void add_local(const Array<double>& values);

    virtual void gather(GenericVector& y,
                        const std::vector<dolfin::la_index>& indices) const;

    virtual void gather(std::vector<double>& x,
                        const std::vector<dolfin::la_index>& indices) const;

    virtual void gather_on_zero(std::vector<double>& x) const;

    virtual void axpy(double a, const GenericVector& x);

    virtual void abs();

    virtual double inner(const GenericVector& v) const;

    virtual double norm(std::string norm_type) const;

    virtual double min() const;

    virtual double max() const;

    virtual double sum() const;

    virtual double sum(const Array<std::size_t>& rows) const;

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

    virtual const TpetraVector& operator*= (const GenericVector& x);

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

    virtual const TpetraVector& operator+= (const GenericVector& x);

    virtual const TpetraVector& operator+= (double a);

    virtual const TpetraVector& operator-= (const GenericVector& x);

    virtual const TpetraVector& operator-= (double a);

    virtual const GenericVector& operator= (const GenericVector& x);

    virtual const TpetraVector& operator= (double a);

    virtual void update_ghost_values();

    //--- Special functions ---

    virtual GenericLinearAlgebraFactory& factory() const;

    //--- Special Tpetra functions ---

    Teuchos::RCP<vector_type> vec() const;

    const TpetraVector& operator= (const TpetraVector& x);

    static void mapdump(Teuchos::RCP<const map_type> xmap,
                        const std::string desc);

    void mapdump(const std::string desc);

    friend class TpetraMatrix;

  private:

    // Initialise Tpetra vector
    void _init(std::pair<std::int64_t, std::int64_t> range,
               const std::vector<dolfin::la_index>& local_to_global);

    // Tpetra multivector - actually a view into the ghosted vector,
    // below
    Teuchos::RCP<vector_type> _x;

    // Tpetra multivector with extra rows for ghost values
    Teuchos::RCP<vector_type> _x_ghosted;

    // MPI Communicator
    Teuchos::RCP<const Teuchos::MpiComm<int>> _comm;

  };

}

#endif

#endif