PETScVector.h

// Copyright (C) 2004-2016 Johan Hoffman, Johan Jansson, Anders Logg
// and Garth N. Wells
//
// 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/>.
//
// Modified by Garth N. Wells, 2005-2010.
// Modified by Kent-Andre Mardal, 2008.
// Modified by Ola Skavhaug, 2008.
// Modified by Martin Alnæs, 2008.
// Modified by Fredrik Valdmanis, 2011.

#ifndef __DOLFIN_PETSC_VECTOR_H
#define __DOLFIN_PETSC_VECTOR_H

#ifdef HAS_PETSC

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

#include <petscsys.h>
#include <petscvec.h>

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

namespace dolfin
{

  class SparsityPattern;
  template<typename T> class Array;


  class PETScVector : public GenericVector, public PETScObject
  {
  public:

    PETScVector();

    explicit PETScVector(MPI_Comm comm);

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

    explicit PETScVector(const SparsityPattern& sparsity_pattern);

    PETScVector(const PETScVector& x);

    explicit PETScVector(Vec x);

    virtual ~PETScVector();

    //--- 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 PETScVector& operator*= (double a);

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

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

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

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

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

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

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

    virtual const PETScVector& operator= (double a);

    virtual void update_ghost_values();

    //--- Special functions ---

    virtual GenericLinearAlgebraFactory& factory() const;

    //--- Special PETSc functions ---

    void set_options_prefix(std::string options_prefix);

    std::string get_options_prefix() const;

    void set_from_options();

    Vec vec() const;

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

    void reset(Vec vec);

  private:

    // Initialise PETSc vector
    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);

    // PETSc Vec pointer
    Vec _x;

    // PETSc norm types
    static const std::map<std::string, NormType> norm_types;

  };

}

#endif

#endif