/usr/include/dolfin/la/Vector.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 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | // Copyright (C) 2007 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 Anders Logg, 2007-2010.
// Modified by Kent-Andre Mardal, 2008.
// Modified by Ola Skavhaug, 2008.
// Modified by Martin Sandve Alnes, 2008.
//
// First added: 2007-07-03
// Last changed: 2011-01-14
#ifndef __DOLFIN_VECTOR_H
#define __DOLFIN_VECTOR_H
#include <string>
#include <utility>
#include <memory>
#include <dolfin/common/types.h>
#include "DefaultFactory.h"
#include "GenericVector.h"
namespace dolfin
{
template<typename T> class Array;
/// This class provides the default DOLFIN vector class,
/// based on the default DOLFIN linear algebra backend.
class Vector : public GenericVector
{
public:
/// Create empty vector
Vector()
{
DefaultFactory factory;
vector = factory.create_vector();
}
/// Create vector of size N
Vector(MPI_Comm comm, std::size_t N)
{
DefaultFactory factory;
vector = factory.create_vector();
vector->init(comm, N);
}
/// Copy constructor
Vector(const Vector& x) : vector(x.vector->copy()) {}
/// Create a Vector from a GenericVetor
Vector(const GenericVector& x) : vector(x.copy()) {}
//--- Implementation of the GenericTensor interface ---
/// Return copy of vector
virtual std::shared_ptr<GenericVector> copy() const
{
std::shared_ptr<Vector> x(new Vector(*this));
return x;
}
/// Set all entries to zero and keep any sparse structure
virtual void zero()
{ vector->zero(); }
/// Finalize assembly of tensor
virtual void apply(std::string mode)
{ vector->apply(mode); }
/// Return MPI communicator
virtual MPI_Comm mpi_comm() const
{ return vector->mpi_comm(); }
/// Return informal string representation (pretty-print)
virtual std::string str(bool verbose) const
{ return "<Vector wrapper of " + vector->str(verbose) + ">"; }
//--- Implementation of the GenericVector interface ---
/// Initialize vector to size N
virtual void init(MPI_Comm comm, std::size_t N)
{ vector->init(comm, N); }
/// Initlialize vector with given ownership range
virtual void init(MPI_Comm comm, std::pair<std::size_t, std::size_t> range)
{ vector->init(comm, 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)
{ vector->init(comm, range, ghost_indices); }
// Bring init function from GenericVector into scope
using GenericVector::init;
/// Return true if vector is empty
virtual bool empty() const
{ return vector->empty(); }
/// Return size of vector
virtual std::size_t size() const
{ return vector->size(); }
/// Return local size of vector
virtual std::size_t local_size() const
{ return vector->local_size(); }
/// Return local ownership range of a vector
virtual std::pair<std::size_t, std::size_t> local_range() const
{ return vector->local_range(); }
/// Determine whether global vector index is owned by this process
virtual bool owns_index(std::size_t i) const
{ return vector->owns_index(i); }
/// Get block of values (values must all live on the local process)
virtual void get_local(double* block, std::size_t m,
const dolfin::la_index* rows) const
{ vector->get_local(block,m,rows); }
/// Set block of values
virtual void set(const double* block, std::size_t m,
const dolfin::la_index* rows)
{ vector->set(block, m, rows); }
/// Add block of values
virtual void add(const double* block, std::size_t m,
const dolfin::la_index* rows)
{ vector->add(block, m, rows); }
/// Get all values on local process
virtual void get_local(std::vector<double>& values) const
{ vector->get_local(values); }
/// Set all values on local process
virtual void set_local(const std::vector<double>& values)
{ vector->set_local(values); }
/// Add values to each entry on local process
virtual void add_local(const Array<double>& values)
{ vector->add_local(values); }
/// Gather entries into local vector x
virtual void gather(GenericVector& x,
const std::vector<dolfin::la_index>& indices) const
{ vector->gather(x, indices); }
/// Gather entries into x
virtual void gather(std::vector<double>& x,
const std::vector<dolfin::la_index>& indices) const
{ vector->gather(x, indices); }
/// Gather all entries into x on process 0
virtual void gather_on_zero(std::vector<double>& x) const
{ vector->gather_on_zero(x); }
/// Add multiple of given vector (AXPY operation)
virtual void axpy(double a, const GenericVector& x)
{ vector->axpy(a, x); }
/// Replace all entries in the vector by their absolute values
virtual void abs()
{ vector->abs(); }
/// Return inner product with given vector
virtual double inner(const GenericVector& x) const
{ return vector->inner(x); }
/// Return norm of vector
virtual double norm(std::string norm_type) const
{ return vector->norm(norm_type); }
/// Return minimum value of vector
virtual double min() const
{ return vector->min(); }
/// Return maximum value of vector
virtual double max() const
{ return vector->max(); }
/// Return sum of values of vector
virtual double sum() const
{ return vector->sum(); }
virtual double sum(const Array<std::size_t>& rows) const
{ return vector->sum(rows); }
/// Multiply vector by given number
virtual const Vector& operator*= (double a)
{ *vector *= a; return *this; }
/// Multiply vector by another vector pointwise
virtual const Vector& operator*= (const GenericVector& x)
{ *vector *= x; return *this; }
/// Divide vector by given number
virtual const Vector& operator/= (double a)
{ *this *= 1.0 / a; return *this; }
/// Add given vector
virtual const Vector& operator+= (const GenericVector& x)
{ axpy(1.0, x); return *this; }
/// Add number to all components of a vector
virtual const GenericVector& operator+= (double a)
{ *vector += a; return *this; }
/// Subtract given vector
virtual const Vector& operator-= (const GenericVector& x)
{ axpy(-1.0, x); return *this; }
/// Subtract number from all components of a vector
virtual const GenericVector& operator-= (double a)
{ *vector -= a; return *this; }
/// Assignment operator
virtual const GenericVector& operator= (const GenericVector& x)
{ *vector = x; return *this; }
/// Assignment operator
const Vector& operator= (double a)
{ *vector = a; return *this; }
/// Return pointer to underlying data (const version)
virtual const double* data() const
{ return vector->data(); }
/// Return pointer to underlying data
virtual double* data()
{ return vector->data(); }
//--- Special functions ---
/// Return linear algebra backend factory
virtual GenericLinearAlgebraFactory& factory() const
{ return vector->factory(); }
//--- Special functions, intended for library use only ---
/// Return concrete instance / unwrap (const version)
virtual const GenericVector* instance() const
{ return vector.get(); }
/// Return concrete instance / unwrap (non-const version)
virtual GenericVector* instance()
{ return vector.get(); }
virtual std::shared_ptr<const LinearAlgebraObject> shared_instance() const
{ return vector; }
virtual std::shared_ptr<LinearAlgebraObject> shared_instance()
{ return vector; }
//--- Special Vector functions ---
/// Assignment operator
const Vector& operator= (const Vector& x)
{ *vector = *x.vector; return *this; }
private:
// Pointer to concrete implementation
std::shared_ptr<GenericVector> vector;
};
}
#endif
|