/usr/include/deal.II/lac/petsc_parallel_block_vector.h is in libdeal.ii-dev 6.3.1-1.1.
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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | //---------------------------------------------------------------------------
// $Id: petsc_parallel_block_vector.h 20934 2010-04-02 13:09:20Z bangerth $
// Version: $Name$
//
// Copyright (C) 2004, 2005, 2006, 2007, 2009, 2010 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__petsc_parallel_block_vector_h
#define __deal2__petsc_parallel_block_vector_h
#include <base/config.h>
#ifdef DEAL_II_USE_PETSC
# include <lac/petsc_parallel_vector.h>
# include <lac/block_indices.h>
# include <lac/block_vector_base.h>
# include <lac/exceptions.h>
DEAL_II_NAMESPACE_OPEN
namespace PETScWrappers
{
// forward declaration
class BlockVector;
namespace MPI
{
/*! @addtogroup PETScWrappers
*@{
*/
/**
* An implementation of block vectors based on the parallel vector class
* implemented in PETScWrappers. While the base class provides for most of the
* interface, this class handles the actual allocation of vectors and provides
* functions that are specific to the underlying vector type.
*
* The model of distribution of data is such that each of the blocks is
* distributed across all MPI processes named in the MPI communicator. I.e. we
* don't just distribute the whole vector, but each component. In the
* constructors and reinit() functions, one therefore not only has to specify
* the sizes of the individual blocks, but also the number of elements of each
* of these blocks to be stored on the local process.
*
* @ingroup Vectors
* @see @ref GlossBlockLA "Block (linear algebra)"
* @author Wolfgang Bangerth, 2004
*/
class BlockVector : public BlockVectorBase<Vector>
{
public:
/**
* Typedef the base class for simpler
* access to its own typedefs.
*/
typedef BlockVectorBase<Vector> BaseClass;
/**
* Typedef the type of the underlying
* vector.
*/
typedef BaseClass::BlockType BlockType;
/**
* Import the typedefs from the base
* class.
*/
typedef BaseClass::value_type value_type;
typedef BaseClass::pointer pointer;
typedef BaseClass::const_pointer const_pointer;
typedef BaseClass::reference reference;
typedef BaseClass::const_reference const_reference;
typedef BaseClass::size_type size_type;
typedef BaseClass::iterator iterator;
typedef BaseClass::const_iterator const_iterator;
/**
* Default constructor. Generate an
* empty vector without any blocks.
*/
BlockVector ();
/**
* Constructor. Generate a block
* vector with @p n_blocks blocks,
* each of which is a parallel
* vector across @p communicator
* with @p block_size elements of
* which @p local_size elements are
* stored on the present process.
*/
explicit BlockVector (const unsigned int n_blocks,
const MPI_Comm &communicator,
const unsigned int block_size,
const unsigned int local_size);
/**
* Copy-Constructor. Set all the
* properties of the parallel vector
* to those of the given argument and
* copy the elements.
*/
BlockVector (const BlockVector &V);
/**
* Constructor. Set the number of
* blocks to
* <tt>block_sizes.size()</tt> and
* initialize each block with
* <tt>block_sizes[i]</tt> zero
* elements. The individual blocks
* are distributed across the given
* communicator, and each store
* <tt>local_elements[i]</tt>
* elements on the present process.
*/
BlockVector (const std::vector<unsigned int> &block_sizes,
const MPI_Comm &communicator,
const std::vector<unsigned int> &local_elements);
/**
* Destructor. Clears memory
*/
~BlockVector ();
/**
* Copy operator: fill all components
* of the vector that are locally
* stored with the given scalar value.
*/
BlockVector & operator = (const value_type s);
/**
* Copy operator for arguments of the
* same type.
*/
BlockVector &
operator= (const BlockVector &V);
/**
* Copy the given sequential
* (non-distributed) block vector
* into the present parallel block
* vector. It is assumed that they
* have the same size, and this
* operation does not change the
* partitioning of the parallel
* vectors by which its elements are
* distributed across several MPI
* processes. What this operation
* therefore does is to copy that
* chunk of the given vector @p v
* that corresponds to elements of
* the target vector that are stored
* locally, and copies them, for each
* of the individual blocks of this
* object. Elements that are not
* stored locally are not touched.
*
* This being a parallel vector, you
* must make sure that @em all
* processes call this function at
* the same time. It is not possible
* to change the local part of a
* parallel vector on only one
* process, independent of what other
* processes do, with this function.
*/
BlockVector &
operator = (const PETScWrappers::BlockVector &v);
/**
* Reinitialize the BlockVector to
* contain @p n_blocks of size @p
* block_size, each of which stores
* @p local_size elements
* locally. The @p communicator
* argument denotes which MPI channel
* each of these blocks shall
* communicate.
*
* If <tt>fast==false</tt>, the vector
* is filled with zeros.
*/
void reinit (const unsigned int n_blocks,
const MPI_Comm &communicator,
const unsigned int block_size,
const unsigned int local_size,
const bool fast = false);
/**
* Reinitialize the BlockVector such
* that it contains
* <tt>block_sizes.size()</tt>
* blocks. Each block is
* reinitialized to dimension
* <tt>block_sizes[i]</tt>. Each of
* them stores
* <tt>local_sizes[i]</tt> elements
* on the present process.
*
* If the number of blocks is the
* same as before this function
* was called, all vectors remain
* the same and reinit() is
* called for each vector.
*
* If <tt>fast==false</tt>, the vector
* is filled with zeros.
*
* Note that you must call this
* (or the other reinit()
* functions) function, rather
* than calling the reinit()
* functions of an individual
* block, to allow the block
* vector to update its caches of
* vector sizes. If you call
* reinit() of one of the
* blocks, then subsequent
* actions on this object may
* yield unpredictable results
* since they may be routed to
* the wrong block.
*/
void reinit (const std::vector<unsigned int> &block_sizes,
const MPI_Comm &communicator,
const std::vector<unsigned int> &local_sizes,
const bool fast=false);
/**
* Change the dimension to that
* of the vector <tt>V</tt>. The same
* applies as for the other
* reinit() function.
*
* The elements of <tt>V</tt> are not
* copied, i.e. this function is
* the same as calling <tt>reinit
* (V.size(), fast)</tt>.
*
* Note that you must call this
* (or the other reinit()
* functions) function, rather
* than calling the reinit()
* functions of an individual
* block, to allow the block
* vector to update its caches of
* vector sizes. If you call
* reinit() on one of the
* blocks, then subsequent
* actions on this object may
* yield unpredictable results
* since they may be routed to
* the wrong block.
*/
void reinit (const BlockVector &V,
const bool fast=false);
/**
* Return a reference to the MPI
* communicator object in use with
* this vector.
*/
const MPI_Comm & get_mpi_communicator () const;
/**
* Swap the contents of this
* vector and the other vector
* <tt>v</tt>. One could do this
* operation with a temporary
* variable and copying over the
* data elements, but this
* function is significantly more
* efficient since it only swaps
* the pointers to the data of
* the two vectors and therefore
* does not need to allocate
* temporary storage and move
* data around.
*
* Limitation: right now this
* function only works if both
* vectors have the same number
* of blocks. If needed, the
* numbers of blocks should be
* exchanged, too.
*
* This function is analog to the
* the swap() function of all C++
* standard containers. Also,
* there is a global function
* swap(u,v) that simply calls
* <tt>u.swap(v)</tt>, again in analogy
* to standard functions.
*/
void swap (BlockVector &v);
/**
* Print to a stream.
*/
void print (std::ostream &out,
const unsigned int precision = 3,
const bool scientific = true,
const bool across = true) const;
/**
* Exception
*/
DeclException0 (ExcIteratorRangeDoesNotMatchVectorSize);
/**
* Exception
*/
DeclException0 (ExcNonMatchingBlockVectors);
};
/*@}*/
/*----------------------- Inline functions ----------------------------------*/
inline
BlockVector::BlockVector ()
{}
inline
BlockVector::BlockVector (const unsigned int n_blocks,
const MPI_Comm &communicator,
const unsigned int block_size,
const unsigned int local_size)
{
reinit (n_blocks, communicator, block_size, local_size);
}
inline
BlockVector::BlockVector (const std::vector<unsigned int> &block_sizes,
const MPI_Comm &communicator,
const std::vector<unsigned int> &local_elements)
{
reinit (block_sizes, communicator, local_elements, false);
}
inline
BlockVector::BlockVector (const BlockVector& v)
:
BlockVectorBase<Vector > ()
{
this->components.resize (v.n_blocks());
this->block_indices = v.block_indices;
for (unsigned int i=0; i<this->n_blocks(); ++i)
this->components[i] = v.components[i];
}
inline
BlockVector &
BlockVector::operator = (const value_type s)
{
BaseClass::operator = (s);
return *this;
}
inline
BlockVector &
BlockVector::operator = (const BlockVector &v)
{
BaseClass::operator = (v);
return *this;
}
inline
BlockVector::~BlockVector ()
{}
inline
void
BlockVector::reinit (const unsigned int n_blocks,
const MPI_Comm &communicator,
const unsigned int block_size,
const unsigned int local_size,
const bool fast)
{
reinit(std::vector<unsigned int>(n_blocks, block_size),
communicator,
std::vector<unsigned int>(n_blocks, local_size),
fast);
}
inline
void
BlockVector::reinit (const std::vector<unsigned int> &block_sizes,
const MPI_Comm &communicator,
const std::vector<unsigned int> &local_sizes,
const bool fast)
{
this->block_indices.reinit (block_sizes);
if (this->components.size() != this->n_blocks())
this->components.resize(this->n_blocks());
for (unsigned int i=0; i<this->n_blocks(); ++i)
this->components[i].reinit(communicator, block_sizes[i],
local_sizes[i], fast);
}
inline
void
BlockVector::reinit (const BlockVector& v,
const bool fast)
{
this->block_indices = v.get_block_indices();
if (this->components.size() != this->n_blocks())
this->components.resize(this->n_blocks());
for (unsigned int i=0;i<this->n_blocks();++i)
block(i).reinit(v.block(i), fast);
}
inline
const MPI_Comm &
BlockVector::get_mpi_communicator () const
{
return block(0).get_mpi_communicator();
}
inline
void
BlockVector::swap (BlockVector &v)
{
Assert (this->n_blocks() == v.n_blocks(),
ExcDimensionMismatch(this->n_blocks(), v.n_blocks()));
for (unsigned int i=0; i<this->n_blocks(); ++i)
this->components[i].swap (v.components[i]);
::dealii::swap (this->block_indices, v.block_indices);
}
inline
void
BlockVector::print (std::ostream &out,
const unsigned int precision,
const bool scientific,
const bool across) const
{
for (unsigned int i=0;i<this->n_blocks();++i)
{
if (across)
out << 'C' << i << ':';
else
out << "Component " << i << std::endl;
this->components[i].print(out, precision, scientific, across);
}
}
/**
* Global function which overloads the default implementation
* of the C++ standard library which uses a temporary object. The
* function simply exchanges the data of the two vectors.
*
* @relates PETScWrappers::MPI::BlockVector
* @author Wolfgang Bangerth, 2000
*/
inline
void swap (BlockVector &u,
BlockVector &v)
{
u.swap (v);
}
}
}
DEAL_II_NAMESPACE_CLOSE
#endif // DEAL_II_USE_PETSC
#endif
|