Reference documentation for deal.II version Git 1ecc23629d 2021-05-18 09:57:04 +0200
PETScWrappers::VectorBase Class Reference

#include <deal.II/lac/petsc_vector_base.h>

Inheritance diagram for PETScWrappers::VectorBase:
[legend]

## Public Types

using value_type = PetscScalar

using real_type = PetscReal

using size_type = types::global_dof_index

using reference = internal::VectorReference

using const_reference = const internal::VectorReference

## Public Member Functions

VectorBase ()

VectorBase (const VectorBase &v)

VectorBase (const Vec &v)

VectorBaseoperator= (const VectorBase &)=delete

virtual ~VectorBase () override

virtual void clear ()

void compress (const VectorOperation::values operation)

VectorBaseoperator= (const PetscScalar s)

bool operator== (const VectorBase &v) const

bool operator!= (const VectorBase &v) const

size_type size () const

size_type local_size () const

size_type locally_owned_size () const

std::pair< size_type, size_typelocal_range () const

bool in_local_range (const size_type index) const

IndexSet locally_owned_elements () const

bool has_ghost_elements () const

void update_ghost_values () const

reference operator() (const size_type index)

PetscScalar operator() (const size_type index) const

reference operator[] (const size_type index)

PetscScalar operator[] (const size_type index) const

void set (const std::vector< size_type > &indices, const std::vector< PetscScalar > &values)

void extract_subvector_to (const std::vector< size_type > &indices, std::vector< PetscScalar > &values) const

template<typename ForwardIterator , typename OutputIterator >
void extract_subvector_to (const ForwardIterator indices_begin, const ForwardIterator indices_end, OutputIterator values_begin) const

void add (const std::vector< size_type > &indices, const std::vector< PetscScalar > &values)

void add (const std::vector< size_type > &indices, const ::Vector< PetscScalar > &values)

void add (const size_type n_elements, const size_type *indices, const PetscScalar *values)

PetscScalar operator* (const VectorBase &vec) const

real_type norm_sqr () const

PetscScalar mean_value () const

real_type l1_norm () const

real_type l2_norm () const

real_type lp_norm (const real_type p) const

real_type linfty_norm () const

PetscScalar add_and_dot (const PetscScalar a, const VectorBase &V, const VectorBase &W)

real_type min () const

real_type max () const

bool all_zero () const

bool is_non_negative () const

VectorBaseoperator*= (const PetscScalar factor)

VectorBaseoperator/= (const PetscScalar factor)

VectorBaseoperator+= (const VectorBase &V)

VectorBaseoperator-= (const VectorBase &V)

void add (const PetscScalar a, const VectorBase &V)

void add (const PetscScalar a, const VectorBase &V, const PetscScalar b, const VectorBase &W)

void sadd (const PetscScalar s, const VectorBase &V)

void sadd (const PetscScalar s, const PetscScalar a, const VectorBase &V)

void scale (const VectorBase &scaling_factors)

void equ (const PetscScalar a, const VectorBase &V)

void write_ascii (const PetscViewerFormat format=PETSC_VIEWER_DEFAULT)

void print (std::ostream &out, const unsigned int precision=3, const bool scientific=true, const bool across=true) const

void swap (VectorBase &v)

operator const Vec & () const

std::size_t memory_consumption () const

virtual const MPI_Commget_mpi_communicator () const

template<class Archive >
void serialize (Archive &ar, const unsigned int version)

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

unsigned int n_subscriptions () const

template<typename StreamType >
void list_subscribers (StreamType &stream) const

void list_subscribers () const

## Static Public Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

## Protected Member Functions

void do_set_add_operation (const size_type n_elements, const size_type *indices, const PetscScalar *values, const bool add_values)

## Protected Attributes

Vec vector

bool ghosted

IndexSet ghost_indices

VectorOperation::values last_action

bool obtained_ownership

## Friends

class internal::VectorReference

## Related Functions

(Note that these are not member functions.)

void swap (VectorBase &u, VectorBase &v)

## Detailed Description

Base class for all vector classes that are implemented on top of the PETSc vector types. Since in PETSc all vector types (i.e. sequential and parallel ones) are built by filling the contents of an abstract object that is only referenced through a pointer of a type that is independent of the actual vector type, we can implement almost all functionality of vectors in this base class. As such, this class can also be used as a deal.II-compatible wrapper for a PETSc Vec object of any type. Derived classes will then only have to provide the functionality to create one or the other kind of vector.

The interface of this class is modeled after the existing Vector class in deal.II. It has almost the same member functions, and is often exchangeable. However, since PETSc only supports a single scalar type (either double, float, or a complex data type), it is not templated, and only works with whatever your PETSc installation has defined the data type PetscScalar to.

Note that PETSc only guarantees that operations do what you expect if the functions VecAssemblyBegin and VecAssemblyEnd have been called after vector assembly. Therefore, you need to call Vector::compress() before you actually use the vector.

Definition at line 250 of file petsc_vector_base.h.

## ◆ value_type

 using PETScWrappers::VectorBase::value_type = PetscScalar

Declare some of the standard types used in all containers. These types parallel those in the C++ standard libraries vector<...> class.

Definition at line 258 of file petsc_vector_base.h.

## ◆ real_type

 using PETScWrappers::VectorBase::real_type = PetscReal

Definition at line 259 of file petsc_vector_base.h.

## ◆ size_type

Definition at line 260 of file petsc_vector_base.h.

## ◆ reference

 using PETScWrappers::VectorBase::reference = internal::VectorReference

Definition at line 261 of file petsc_vector_base.h.

## ◆ const_reference

 using PETScWrappers::VectorBase::const_reference = const internal::VectorReference

Definition at line 262 of file petsc_vector_base.h.

## ◆ VectorBase() [1/3]

 PETScWrappers::VectorBase::VectorBase ( )

Default constructor. It doesn't do anything, derived classes will have to initialize the data.

Definition at line 116 of file petsc_vector_base.cc.

## ◆ VectorBase() [2/3]

 PETScWrappers::VectorBase::VectorBase ( const VectorBase & v )

Copy constructor. Sets the dimension to that of the given vector, and copies all elements.

Definition at line 129 of file petsc_vector_base.cc.

## ◆ VectorBase() [3/3]

 PETScWrappers::VectorBase::VectorBase ( const Vec & v )
explicit

Initialize a Vector from a PETSc Vec object. Note that we do not copy the vector and we do not obtain ownership, so we do not destroy the PETSc object in the destructor.

Definition at line 149 of file petsc_vector_base.cc.

## ◆ ~VectorBase()

 PETScWrappers::VectorBase::~VectorBase ( )
overridevirtual

Destructor.

Definition at line 163 of file petsc_vector_base.cc.

## ◆ operator=() [1/2]

 VectorBase& PETScWrappers::VectorBase::operator= ( const VectorBase & )
delete

The copy assignment operator is deleted to avoid accidental usage with unexpected behavior.

## ◆ clear()

 void PETScWrappers::VectorBase::clear ( )
virtual

Release all memory and return to a state just like after having called the default constructor.

Reimplemented in PETScWrappers::MPI::Vector.

Definition at line 176 of file petsc_vector_base.cc.

## ◆ compress()

 void PETScWrappers::VectorBase::compress ( const VectorOperation::values operation )

Compress the underlying representation of the PETSc object, i.e. flush the buffers of the vector object if it has any. This function is necessary after writing into a vector element-by-element and before anything else can be done on it.

Definition at line 373 of file petsc_vector_base.cc.

## ◆ operator=() [2/2]

 VectorBase & PETScWrappers::VectorBase::operator= ( const PetscScalar s )

Set all components of the vector to the given number s. Simply pass this down to the individual block objects, but we still need to declare this function to make the example given in the discussion about making the constructor explicit work.

Since the semantics of assigning a scalar to a vector are not immediately clear, this operator should really only be used if you want to set the entire vector to zero. This allows the intuitive notation v=0. Assigning other values is deprecated and may be disallowed in the future.

Definition at line 193 of file petsc_vector_base.cc.

## ◆ operator==()

 bool PETScWrappers::VectorBase::operator== ( const VectorBase & v ) const

Test for equality. This function assumes that the present vector and the one to compare with have the same size already, since comparing vectors of different sizes makes not much sense anyway.

Definition at line 221 of file petsc_vector_base.cc.

## ◆ operator!=()

 bool PETScWrappers::VectorBase::operator!= ( const VectorBase & v ) const

Test for inequality. This function assumes that the present vector and the one to compare with have the same size already, since comparing vectors of different sizes makes not much sense anyway.

Definition at line 235 of file petsc_vector_base.cc.

## ◆ size()

 VectorBase::size_type PETScWrappers::VectorBase::size ( ) const

Return the global dimension of the vector.

Definition at line 249 of file petsc_vector_base.cc.

## ◆ local_size()

 VectorBase::size_type PETScWrappers::VectorBase::local_size ( ) const

Return the local dimension of the vector, i.e. the number of elements stored on the present MPI process. For sequential vectors, this number is the same as size(), but for parallel vectors it may be smaller.

To figure out which elements exactly are stored locally, use local_range() or locally_owned_elements().

Deprecated:

Definition at line 273 of file petsc_vector_base.cc.

## ◆ locally_owned_size()

 VectorBase::size_type PETScWrappers::VectorBase::locally_owned_size ( ) const

Return the local dimension of the vector, i.e. the number of elements stored on the present MPI process. For sequential vectors, this number is the same as size(), but for parallel vectors it may be smaller.

To figure out which elements exactly are stored locally, use local_range() or locally_owned_elements().

Definition at line 261 of file petsc_vector_base.cc.

## ◆ local_range()

 std::pair< VectorBase::size_type, VectorBase::size_type > PETScWrappers::VectorBase::local_range ( ) const

Return a pair of indices indicating which elements of this vector are stored locally. The first number is the index of the first element stored, the second the index of the one past the last one that is stored locally. If this is a sequential vector, then the result will be the pair (0,N), otherwise it will be a pair (i,i+n), where n=locally_owned_size().

Definition at line 285 of file petsc_vector_base.cc.

## ◆ in_local_range()

 bool PETScWrappers::VectorBase::in_local_range ( const size_type index ) const

Return whether index is in the local range or not, see also local_range().

## ◆ locally_owned_elements()

 IndexSet PETScWrappers::VectorBase::locally_owned_elements ( ) const

Return an index set that describes which elements of this vector are owned by the current processor. Note that this index set does not include elements this vector may store locally as ghost elements but that are in fact owned by another processor. As a consequence, the index sets returned on different processors if this is a distributed vector will form disjoint sets that add up to the complete index set. Obviously, if a vector is created on only one processor, then the result would satisfy

vec.locally_owned_elements() == complete_index_set (vec.size())

## ◆ has_ghost_elements()

 bool PETScWrappers::VectorBase::has_ghost_elements ( ) const

Return if the vector contains ghost elements.

vectors with ghost elements

## ◆ update_ghost_values()

 void PETScWrappers::VectorBase::update_ghost_values ( ) const

This function only exists for compatibility with the LinearAlgebra::distributed::Vector class and does nothing: this class implements ghost value updates in a different way that is a better fit with the underlying PETSc vector object.

## ◆ operator()() [1/2]

 reference PETScWrappers::VectorBase::operator() ( const size_type index )

## ◆ operator()() [2/2]

 PetscScalar PETScWrappers::VectorBase::operator() ( const size_type index ) const

## ◆ operator[]() [1/2]

 reference PETScWrappers::VectorBase::operator[] ( const size_type index )

Exactly the same as operator().

## ◆ operator[]() [2/2]

 PetscScalar PETScWrappers::VectorBase::operator[] ( const size_type index ) const

Exactly the same as operator().

## ◆ set()

 void PETScWrappers::VectorBase::set ( const std::vector< size_type > & indices, const std::vector< PetscScalar > & values )

A collective set operation: instead of setting individual elements of a vector, this function allows to set a whole set of elements at once. The indices of the elements to be set are stated in the first argument, the corresponding values in the second.

Definition at line 298 of file petsc_vector_base.cc.

## ◆ extract_subvector_to() [1/2]

 void PETScWrappers::VectorBase::extract_subvector_to ( const std::vector< size_type > & indices, std::vector< PetscScalar > & values ) const

Instead of getting individual elements of a vector via operator(), this function allows getting a whole set of elements at once. The indices of the elements to be read are stated in the first argument, the corresponding values are returned in the second.

If the current vector is called v, then this function is the equivalent to the code

for (unsigned int i=0; i<indices.size(); ++i)
values[i] = v[indices[i]];
Precondition
The sizes of the indices and values arrays must be identical.

## ◆ extract_subvector_to() [2/2]

template<typename ForwardIterator , typename OutputIterator >
 void PETScWrappers::VectorBase::extract_subvector_to ( const ForwardIterator indices_begin, const ForwardIterator indices_end, OutputIterator values_begin ) const

Instead of getting individual elements of a vector via operator(), this function allows getting a whole set of elements at once. In contrast to the previous function, this function obtains the indices of the elements by dereferencing all elements of the iterator range provided by the first two arguments, and puts the vector values into memory locations obtained by dereferencing a range of iterators starting at the location pointed to by the third argument.

If the current vector is called v, then this function is the equivalent to the code

ForwardIterator indices_p = indices_begin;
OutputIterator values_p = values_begin;
while (indices_p != indices_end)
{
*values_p = v[*indices_p];
++indices_p;
++values_p;
}
Precondition
It must be possible to write into as many memory locations starting at values_begin as there are iterators between indices_begin and indices_end.

 void PETScWrappers::VectorBase::add ( const std::vector< size_type > & indices, const std::vector< PetscScalar > & values )

A collective add operation: This function adds a whole set of values stored in values to the vector components specified by indices.

Definition at line 309 of file petsc_vector_base.cc.

 void PETScWrappers::VectorBase::add ( const std::vector< size_type > & indices, const ::Vector< PetscScalar > & values )

This is a second collective add operation. As a difference, this function takes a deal.II vector of values.

Definition at line 320 of file petsc_vector_base.cc.

 void PETScWrappers::VectorBase::add ( const size_type n_elements, const size_type * indices, const PetscScalar * values )

Take an address where n_elements are stored contiguously and add them into the vector. Handles all cases which are not covered by the other two add() functions above.

Definition at line 331 of file petsc_vector_base.cc.

## ◆ operator*()

 PetscScalar PETScWrappers::VectorBase::operator* ( const VectorBase & vec ) const

Return the scalar product of two vectors. The vectors must have the same size.

For complex valued vector, this gives $$\left(v^\ast,vec\right)$$.

Definition at line 340 of file petsc_vector_base.cc.

## ◆ norm_sqr()

 VectorBase::real_type PETScWrappers::VectorBase::norm_sqr ( ) const

Return the square of the $$l_2$$-norm.

Definition at line 433 of file petsc_vector_base.cc.

## ◆ mean_value()

 PetscScalar PETScWrappers::VectorBase::mean_value ( ) const

Return the mean value of the elements of this vector.

Definition at line 442 of file petsc_vector_base.cc.

## ◆ l1_norm()

 VectorBase::real_type PETScWrappers::VectorBase::l1_norm ( ) const

$$l_1$$-norm of the vector. The sum of the absolute values.

Note
In complex-valued PETSc priori to 3.7.0 this norm is implemented as the sum of absolute values of real and imaginary parts of elements of a complex vector.

Definition at line 493 of file petsc_vector_base.cc.

## ◆ l2_norm()

 VectorBase::real_type PETScWrappers::VectorBase::l2_norm ( ) const

$$l_2$$-norm of the vector. The square root of the sum of the squares of the elements.

Definition at line 506 of file petsc_vector_base.cc.

## ◆ lp_norm()

 VectorBase::real_type PETScWrappers::VectorBase::lp_norm ( const real_type p ) const

$$l_p$$-norm of the vector. The pth root of the sum of the pth powers of the absolute values of the elements.

Definition at line 519 of file petsc_vector_base.cc.

## ◆ linfty_norm()

 VectorBase::real_type PETScWrappers::VectorBase::linfty_norm ( ) const

$$l_\infty$$-norm of the vector. Return the value of the vector element with the maximum absolute value.

Definition at line 561 of file petsc_vector_base.cc.

 PetscScalar PETScWrappers::VectorBase::add_and_dot ( const PetscScalar a, const VectorBase & V, const VectorBase & W )

Performs a combined operation of a vector addition and a subsequent inner product, returning the value of the inner product. In other words, the result of this function is the same as if the user called

return_value = *this * W;

The reason this function exists is for compatibility with deal.II's own vector classes which can implement this functionality with less memory transfer. However, for PETSc vectors such a combined operation is not natively supported and thus the cost is completely equivalent as calling the two methods separately.

For complex-valued vectors, the scalar product in the second step is implemented as $$\left<v,w\right>=\sum_i v_i \bar{w_i}$$.

Definition at line 362 of file petsc_vector_base.cc.

## ◆ min()

 VectorBase::real_type PETScWrappers::VectorBase::min ( ) const

Return the value of the vector element with the largest negative value.

Deprecated:
This function has been deprecated to improve compatibility with other classes inheriting from VectorSpaceVector. If you need to use this functionality then use the PETSc function VecMin instead.

Definition at line 574 of file petsc_vector_base.cc.

## ◆ max()

 VectorBase::real_type PETScWrappers::VectorBase::max ( ) const

Return the value of the vector element with the largest positive value.

Deprecated:
This function has been deprecated to improve compatibility with other classes inheriting from VectorSpaceVector. If you need to use this functionality then use the PETSc function VecMax instead.

Definition at line 587 of file petsc_vector_base.cc.

## ◆ all_zero()

 bool PETScWrappers::VectorBase::all_zero ( ) const

Return whether the vector contains only elements with value zero. This is a collective operation. This function is expensive, because potentially all elements have to be checked.

Definition at line 601 of file petsc_vector_base.cc.

## ◆ is_non_negative()

 bool PETScWrappers::VectorBase::is_non_negative ( ) const

Return true if the vector has no negative entries, i.e. all entries are zero or positive. This function is used, for example, to check whether refinement indicators are really all positive (or zero).

Deprecated:
This function has been deprecated to improve compatibility with other classes inheriting from VectorSpaceVector.

Definition at line 655 of file petsc_vector_base.cc.

## ◆ operator*=()

 VectorBase & PETScWrappers::VectorBase::operator*= ( const PetscScalar factor )

Multiply the entire vector by a fixed factor.

Definition at line 687 of file petsc_vector_base.cc.

## ◆ operator/=()

 VectorBase & PETScWrappers::VectorBase::operator/= ( const PetscScalar factor )

Divide the entire vector by a fixed factor.

Definition at line 701 of file petsc_vector_base.cc.

## ◆ operator+=()

 VectorBase & PETScWrappers::VectorBase::operator+= ( const VectorBase & V )

Add the given vector to the present one.

Definition at line 718 of file petsc_vector_base.cc.

## ◆ operator-=()

 VectorBase & PETScWrappers::VectorBase::operator-= ( const VectorBase & V )

Subtract the given vector from the present one.

Definition at line 730 of file petsc_vector_base.cc.

 void PETScWrappers::VectorBase::add ( const PetscScalar s )

Addition of s to all components. Note that s is a scalar and not a vector.

Definition at line 742 of file petsc_vector_base.cc.

 void PETScWrappers::VectorBase::add ( const PetscScalar a, const VectorBase & V )

Simple addition of a multiple of a vector, i.e. *this += a*V.

Definition at line 754 of file petsc_vector_base.cc.

 void PETScWrappers::VectorBase::add ( const PetscScalar a, const VectorBase & V, const PetscScalar b, const VectorBase & W )

Multiple addition of scaled vectors, i.e. *this += a*V+b*W.

Definition at line 766 of file petsc_vector_base.cc.

 void PETScWrappers::VectorBase::sadd ( const PetscScalar s, const VectorBase & V )

Scaling and simple vector addition, i.e. *this = s*(*this)+V.

Definition at line 785 of file petsc_vector_base.cc.

 void PETScWrappers::VectorBase::sadd ( const PetscScalar s, const PetscScalar a, const VectorBase & V )

Scaling and simple addition, i.e. *this = s*(*this)+a*V.

Definition at line 797 of file petsc_vector_base.cc.

## ◆ scale()

 void PETScWrappers::VectorBase::scale ( const VectorBase & scaling_factors )

Scale each element of this vector by the corresponding element in the argument. This function is mostly meant to simulate multiplication (and immediate re-assignment) by a diagonal scaling matrix.

Definition at line 815 of file petsc_vector_base.cc.

## ◆ equ()

 void PETScWrappers::VectorBase::equ ( const PetscScalar a, const VectorBase & V )

Assignment *this = a*V.

Definition at line 825 of file petsc_vector_base.cc.

## ◆ write_ascii()

 void PETScWrappers::VectorBase::write_ascii ( const PetscViewerFormat format = PETSC_VIEWER_DEFAULT )

Prints the PETSc vector object values using PETSc internal vector viewer function VecView. The default format prints the vector's contents, including indices of vector elements. For other valid view formats, consult http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecView.html

Definition at line 844 of file petsc_vector_base.cc.

## ◆ print()

 void PETScWrappers::VectorBase::print ( std::ostream & out, const unsigned int precision = 3, const bool scientific = true, const bool across = true ) const

Print to a stream. precision denotes the desired precision with which values shall be printed, scientific whether scientific notation shall be used. If across is true then the vector is printed in a line, while if false then the elements are printed on a separate line each.

Definition at line 861 of file petsc_vector_base.cc.

## ◆ swap()

 void PETScWrappers::VectorBase::swap ( VectorBase & v )

Swap the contents of this vector and the other vector v. 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.

This function is analogous to the swap function of all C++ standard containers. Also, there is a global function swap(u,v) that simply calls u.swap(v), again in analogy to standard functions.

Definition at line 908 of file petsc_vector_base.cc.

## ◆ operator const Vec &()

 PETScWrappers::VectorBase::operator const Vec & ( ) const

Conversion operator to gain access to the underlying PETSc type. If you do this, you cut this class off some information it may need, so this conversion operator should only be used if you know what you do. In particular, it should only be used for read-only operations into the vector.

Definition at line 916 of file petsc_vector_base.cc.

## ◆ memory_consumption()

 std::size_t PETScWrappers::VectorBase::memory_consumption ( ) const

Estimate for the memory consumption (not implemented for this class).

Definition at line 923 of file petsc_vector_base.cc.

## ◆ get_mpi_communicator()

 virtual const MPI_Comm& PETScWrappers::VectorBase::get_mpi_communicator ( ) const
virtual

Return a reference to the MPI communicator object in use with this object.

Reimplemented in PETScWrappers::MPI::Vector.

 void PETScWrappers::VectorBase::do_set_add_operation ( const size_type n_elements, const size_type * indices, const PetscScalar * values, const bool add_values )
protected

Collective set or add operation: This function is invoked by the collective set and add with the add_values flag set to the corresponding value.

Definition at line 945 of file petsc_vector_base.cc.

## ◆ subscribe()

 void Subscriptor::subscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

## ◆ unsubscribe()

 void Subscriptor::unsubscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

## ◆ n_subscriptions()

 unsigned int Subscriptor::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 301 of file subscriptor.h.

## ◆ list_subscribers() [1/2]

template<typename StreamType >
 void Subscriptor::list_subscribers ( StreamType & stream ) const
inlineinherited

List the subscribers to the input stream.

Definition at line 318 of file subscriptor.h.

## ◆ list_subscribers() [2/2]

 void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

## ◆ serialize()

template<class Archive >
 void Subscriptor::serialize ( Archive & ar, const unsigned int version )
inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 310 of file subscriptor.h.

## ◆ internal::VectorReference

 friend class internal::VectorReference
friend

Definition at line 820 of file petsc_vector_base.h.

## ◆ swap()

 void swap ( VectorBase & u, VectorBase & v )
related

Global function swap 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.

Definition at line 853 of file petsc_vector_base.h.

## ◆ vector

 Vec PETScWrappers::VectorBase::vector
protected

A generic vector object in PETSc. The actual type, a sequential vector, is set in the constructor.

Definition at line 796 of file petsc_vector_base.h.

## ◆ ghosted

 bool PETScWrappers::VectorBase::ghosted
protected

Denotes if this vector has ghost indices associated with it. This means that at least one of the processes in a parallel program has at least one ghost index.

Definition at line 803 of file petsc_vector_base.h.

## ◆ ghost_indices

 IndexSet PETScWrappers::VectorBase::ghost_indices
protected

This vector contains the global indices of the ghost values. The location in this vector denotes the local numbering, which is used in PETSc.

Definition at line 810 of file petsc_vector_base.h.

## ◆ last_action

 VectorOperation::values PETScWrappers::VectorBase::last_action
mutableprotected

Store whether the last action was a write or add operation. This variable is mutable so that the accessor classes can write to it, even though the vector object they refer to is constant.

Definition at line 817 of file petsc_vector_base.h.

## ◆ obtained_ownership

 bool PETScWrappers::VectorBase::obtained_ownership
protected

Specifies if the vector is the owner of the PETSc Vec. This is true if it got created by this class and determines if it gets destroyed in the destructor.

Definition at line 827 of file petsc_vector_base.h.

The documentation for this class was generated from the following files: