/usr/include/dolfin/la/EpetraVector.h is in libdolfin-dev 1.4.0+dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 | // Copyright (C) 2008 Martin Sandve Alnes, Kent-Andre Mardal and Johannes Ring
//
// 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 Anders Logg, 2008-2010.
// Modified by Garth N. Wells, 2008-2009.
//
// First added: 2008-04-21
// Last changed: 2011-01-14
#ifndef __EPETRA_VECTOR_H
#define __EPETRA_VECTOR_H
#ifdef HAS_TRILINOS
#include <map>
#include <string>
#include <utility>
#include <vector>
#include <memory>
#include <boost/unordered_map.hpp>
#include <boost/unordered_set.hpp>
#include <dolfin/common/types.h>
#include "GenericVector.h"
class Epetra_FEVector;
class Epetra_MultiVector;
class Epetra_Vector;
class Epetra_BlockMap;
namespace dolfin
{
template <typename T> class Array;
class GenericVector;
/// This class provides a simple vector class based on Epetra.
/// It is a simple wrapper for an Epetra vector object (Epetra_FEVector)
/// implementing the GenericVector interface.
///
/// The interface is intentionally simple. For advanced usage,
/// access the Epetra_FEVector object using the function vec() or vec_ptr()
/// and use the standard Epetra interface.
class EpetraVector: public GenericVector
{
public:
/// Create empty vector
EpetraVector();
/// Create vector of size N
EpetraVector(MPI_Comm comm, std::size_t N);
/// Copy constructor
EpetraVector(const EpetraVector& x);
/// Create vector view from given Epetra_FEVector pointer
explicit EpetraVector(std::shared_ptr<Epetra_FEVector> vector);
/// Create vector from given Epetra_BlockMap
explicit EpetraVector(const Epetra_BlockMap& map);
/// Destructor
virtual ~EpetraVector();
//--- Implementation of the GenericTensor interface ---
/// Set all entries to zero and keep any sparse structure
virtual void zero();
/// Finalize assembly of tensor
virtual void apply(std::string mode);
/// Return MPI communicator
virtual MPI_Comm mpi_comm() const;
/// Return informal string representation (pretty-print)
virtual std::string str(bool verbose) const;
//--- Implementation of the GenericVector interface ---
/// Return copy of vector
virtual std::shared_ptr<GenericVector> copy() const;
/// Initialize vector to size N
virtual void init(MPI_Comm comm, std::size_t N);
/// Initialize vector with given ownership range
virtual void init(MPI_Comm comm,
std::pair<std::size_t, std::size_t> range);
/// Initialize vector with given ownership range and with ghost
/// values
virtual void init(MPI_Comm comm,
std::pair<std::size_t, std::size_t> range,
const std::vector<la_index>& ghost_indices);
/// Return true if vector is empty
virtual bool empty() const;
/// Return size of vector
virtual std::size_t size() const;
/// Return size of local vector
virtual std::size_t local_size() const;
/// Return local ownership range of a vector
virtual std::pair<std::size_t, std::size_t> local_range() const;
/// Determine whether global vector index is owned by this process
virtual bool owns_index(std::size_t i) const;
/// Set block of values
virtual void set(const double* block, std::size_t m,
const dolfin::la_index* rows);
/// Add block of values
virtual void add(const double* block, std::size_t m,
const dolfin::la_index* rows);
virtual void get_local(double* block, std::size_t m,
const dolfin::la_index* rows) const;
/// Get all values on local process
virtual void get_local(std::vector<double>& values) const;
/// Set all values on local process
virtual void set_local(const std::vector<double>& values);
/// Add all values to each entry on local process
virtual void add_local(const Array<double>& values);
/// Gather entries into local vector x
virtual void gather(GenericVector& x,
const std::vector<dolfin::la_index>& indices) const;
/// Gather entries into x
virtual void gather(std::vector<double>& x,
const std::vector<dolfin::la_index>& indices) const;
/// Gather all entries into x on process 0
virtual void gather_on_zero(std::vector<double>& x) const;
/// Add multiple of given vector (AXPY operation)
virtual void axpy(double a, const GenericVector& x);
/// Replace all entries in the vector by their absolute values
virtual void abs();
/// Return inner product with given vector
virtual double inner(const GenericVector& vector) const;
/// Return norm of vector
virtual double norm(std::string norm_type) const;
/// Return minimum value of vector
virtual double min() const;
/// Return maximum value of vector
virtual double max() const;
/// Return sum of values of vector
virtual double sum() const;
/// Return sum of selected rows in vector
virtual double sum(const Array<std::size_t>& rows) const;
/// Multiply vector by given number
virtual const EpetraVector& operator*= (double a);
/// Multiply vector by another vector pointwise
virtual const EpetraVector& operator*= (const GenericVector& x);
/// Divide vector by given number
virtual const EpetraVector& operator/= (double a);
/// Add given vector
virtual const EpetraVector& operator+= (const GenericVector& x);
/// Add number to all components of a vector
virtual const EpetraVector& operator+= (double a);
/// Subtract given vector
virtual const EpetraVector& operator-= (const GenericVector& x);
/// Subtract number from all components of a vector
virtual const EpetraVector& operator-= (double a);
/// Assignment operator
virtual const EpetraVector& operator= (const GenericVector& x);
/// Assignment operator
virtual const EpetraVector& operator= (double a);
virtual void update_ghost_values();
//--- Special functions ---
/// Return linear algebra backend factory
virtual GenericLinearAlgebraFactory& factory() const;
//--- Special Epetra functions ---
/// Initialize Epetra_FEVector with Epetra map
void init(const Epetra_BlockMap& map);
/// Return Epetra_FEVector pointer
std::shared_ptr<Epetra_FEVector> vec() const;
/// Assignment operator
const EpetraVector& operator= (const EpetraVector& x);
// Bring init function from GenericVector into scope
using GenericTensor::init;
private:
// Epetra_FEVector pointer
std::shared_ptr<Epetra_FEVector> _x;
// Epetra_FEVector pointer
std::shared_ptr<Epetra_Vector> x_ghost;
// Global-to-local map for ghost values
boost::unordered_map<std::size_t, std::size_t> ghost_global_to_local;
// Cache of off-process 'set' values (versus 'add') to be
// communicated
boost::unordered_map<std::size_t, double> off_process_set_values;
};
}
#endif
#endif
|