Reference documentation for deal.II version Git d4ec8156ca 2019-11-18 14:03:00 -0700
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
LinearAlgebra::EpetraWrappers::Vector Class Reference

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

Inheritance diagram for LinearAlgebra::EpetraWrappers::Vector:
[legend]

Public Member Functions

 Vector ()
 
 Vector (const Vector &V)
 
 Vector (const IndexSet &parallel_partitioner, const MPI_Comm &communicator)
 
void reinit (const IndexSet &parallel_partitioner, const MPI_Comm &communicator, const bool omit_zeroing_entries=false)
 
virtual void reinit (const VectorSpaceVector< double > &V, const bool omit_zeroing_entries=false) override
 
Vectoroperator= (const Vector &V)
 
virtual Vectoroperator= (const double s) override
 
virtual void import (const ReadWriteVector< double > &V, VectorOperation::values operation, std::shared_ptr< const CommunicationPatternBase > communication_pattern=std::shared_ptr< const CommunicationPatternBase >()) override
 
virtual Vectoroperator*= (const double factor) override
 
virtual Vectoroperator/= (const double factor) override
 
virtual Vectoroperator+= (const VectorSpaceVector< double > &V) override
 
virtual Vectoroperator-= (const VectorSpaceVector< double > &V) override
 
virtual double operator* (const VectorSpaceVector< double > &V) const override
 
virtual void add (const double a) override
 
virtual void add (const double a, const VectorSpaceVector< double > &V) override
 
virtual void add (const double a, const VectorSpaceVector< double > &V, const double b, const VectorSpaceVector< double > &W) override
 
virtual void sadd (const double s, const double a, const VectorSpaceVector< double > &V) override
 
virtual void scale (const VectorSpaceVector< double > &scaling_factors) override
 
virtual void equ (const double a, const VectorSpaceVector< double > &V) override
 
virtual bool all_zero () const override
 
virtual double mean_value () const override
 
virtual double l1_norm () const override
 
virtual double l2_norm () const override
 
virtual double linfty_norm () const override
 
virtual double add_and_dot (const double a, const VectorSpaceVector< double > &V, const VectorSpaceVector< double > &W) override
 
bool has_ghost_elements () const
 
virtual size_type size () const override
 
MPI_Comm get_mpi_communicator () const
 
virtual ::IndexSet locally_owned_elements () const override
 
const Epetra_FEVector & trilinos_vector () const
 
Epetra_FEVector & trilinos_vector ()
 
virtual void print (std::ostream &out, const unsigned int precision=3, const bool scientific=true, const bool across=true) const override
 
virtual std::size_t memory_consumption () const override
 
- Public Member Functions inherited from LinearAlgebra::VectorSpaceVector< double >
virtual void compress (VectorOperation::values)
 
virtual ~VectorSpaceVector ()=default
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Static Public Member Functions

static ::ExceptionBaseExcDifferentParallelPartitioning ()
 
static ::ExceptionBaseExcVectorTypeNotCompatible ()
 
static ::ExceptionBaseExcTrilinosError (int arg1)
 
- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Private Member Functions

void create_epetra_comm_pattern (const IndexSet &source_index_set, const MPI_Comm &mpi_comm)
 

Private Attributes

std::unique_ptr< Epetra_FEVector > vector
 
::IndexSet source_stored_elements
 
std::shared_ptr< const CommunicationPatternepetra_comm_pattern
 

Detailed Description

This class implements a wrapper to the Trilinos distributed vector class Epetra_FEVector. This class is derived from the LinearAlgebra::VectorSpaceVector class. Note however that Epetra only works with Number = double. This class requires Trilinos to be compiled with MPI support.

Author
Bruno Turcksin, 2015

Definition at line 65 of file trilinos_epetra_vector.h.

Constructor & Destructor Documentation

◆ Vector() [1/3]

Vector< Number >::Vector ( )

Constructor. Create a vector of dimension zero.

Definition at line 43 of file trilinos_epetra_vector.cc.

◆ Vector() [2/3]

Vector< Number >::Vector ( const Vector V)

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

Definition at line 51 of file trilinos_epetra_vector.cc.

◆ Vector() [3/3]

Vector< Number >::Vector ( const IndexSet parallel_partitioner,
const MPI_Comm &  communicator 
)
explicit

This constructor takes an IndexSet that defines how to distribute the individual components among the MPI processors. Since it also includes information about the size of the vector, this is all we need to generate a parallel vector.

Definition at line 58 of file trilinos_epetra_vector.cc.

Member Function Documentation

◆ reinit() [1/2]

void Vector< Number >::reinit ( const IndexSet parallel_partitioner,
const MPI_Comm &  communicator,
const bool  omit_zeroing_entries = false 
)

Reinit functionality. This function destroys the old vector content and generates a new one based on the input partitioning. The flag omit_zeroing_entries determines whether the vector should be filled with zero (false) or left untouched (true).

Definition at line 68 of file trilinos_epetra_vector.cc.

◆ reinit() [2/2]

void Vector< Number >::reinit ( const VectorSpaceVector< double > &  V,
const bool  omit_zeroing_entries = false 
)
overridevirtual

Change the dimension to that of the vector V. The elements of V are not copied.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 87 of file trilinos_epetra_vector.cc.

◆ operator=() [1/2]

Vector & Vector< Number >::operator= ( const Vector V)

Copy function. This function takes a Vector and copies all the elements. The Vector will have the same parallel distribution as V.

Definition at line 105 of file trilinos_epetra_vector.cc.

◆ operator=() [2/2]

Vector & Vector< Number >::operator= ( const double  s)
overridevirtual

Sets all elements of the vector to the scalar s. This operation is only allowed if s is equal to zero.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 136 of file trilinos_epetra_vector.cc.

◆ import()

void Vector< Number >::import ( const ReadWriteVector< double > &  V,
VectorOperation::values  operation,
std::shared_ptr< const CommunicationPatternBase communication_pattern = std::shared_ptr<const CommunicationPatternBase>() 
)
overridevirtual

Imports all the elements present in the vector's IndexSet from the input vector V. VectorOperation::values operation is used to decide if the elements in V should be added to the current vector or replace the current elements. The last parameter can be used if the same communication pattern is used multiple times. This can be used to improve performance.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 150 of file trilinos_epetra_vector.cc.

◆ operator*=()

Vector & Vector< Number >::operator*= ( const double  factor)
overridevirtual

Multiply the entire vector by a fixed factor.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 205 of file trilinos_epetra_vector.cc.

◆ operator/=()

Vector & Vector< Number >::operator/= ( const double  factor)
overridevirtual

Divide the entire vector by a fixed factor.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 216 of file trilinos_epetra_vector.cc.

◆ operator+=()

Vector & Vector< Number >::operator+= ( const VectorSpaceVector< double > &  V)
overridevirtual

Add the vector V to the present one.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 228 of file trilinos_epetra_vector.cc.

◆ operator-=()

Vector & Vector< Number >::operator-= ( const VectorSpaceVector< double > &  V)
overridevirtual

Subtract the vector V from the present one.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 280 of file trilinos_epetra_vector.cc.

◆ operator*()

double Vector< Number >::operator* ( const VectorSpaceVector< double > &  V) const
overridevirtual

Return the scalar product of two vectors. The vectors need to have the same layout.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 289 of file trilinos_epetra_vector.cc.

◆ add() [1/3]

void Vector< Number >::add ( const double  a)
overridevirtual

Add a to all components. Note that is a scalar not a vector.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 313 of file trilinos_epetra_vector.cc.

◆ add() [2/3]

void Vector< Number >::add ( const double  a,
const VectorSpaceVector< double > &  V 
)
overridevirtual

Simple addition of a multiple of a vector, i.e. *this += a*V. The vectors need to have the same layout.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 324 of file trilinos_epetra_vector.cc.

◆ add() [3/3]

void Vector< Number >::add ( const double  a,
const VectorSpaceVector< double > &  V,
const double  b,
const VectorSpaceVector< double > &  W 
)
overridevirtual

Multiple addition of multiple of a vector, i.e. *this> += a*V+b*W. The vectors need to have the same layout.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 344 of file trilinos_epetra_vector.cc.

◆ sadd()

void Vector< Number >::sadd ( const double  s,
const double  a,
const VectorSpaceVector< double > &  V 
)
overridevirtual

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

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 376 of file trilinos_epetra_vector.cc.

◆ scale()

void Vector< Number >::scale ( const VectorSpaceVector< double > &  scaling_factors)
overridevirtual

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. The vectors need to have the same layout.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 395 of file trilinos_epetra_vector.cc.

◆ equ()

void Vector< Number >::equ ( const double  a,
const VectorSpaceVector< double > &  V 
)
overridevirtual

Assignment *this = a*V.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 418 of file trilinos_epetra_vector.cc.

◆ all_zero()

bool Vector< Number >::all_zero ( ) const
overridevirtual

Return whether the vector contains only elements with value zero.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 441 of file trilinos_epetra_vector.cc.

◆ mean_value()

double Vector< Number >::mean_value ( ) const
overridevirtual

Return the mean value of the element of this vector.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 470 of file trilinos_epetra_vector.cc.

◆ l1_norm()

double Vector< Number >::l1_norm ( ) const
overridevirtual

Return the l1 norm of the vector (i.e., the sum of the absolute values of all entries among all processors).

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 484 of file trilinos_epetra_vector.cc.

◆ l2_norm()

double Vector< Number >::l2_norm ( ) const
overridevirtual

Return the l2 norm of the vector (i.e., the square root of the sum of the square of all entries among all processors).

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 497 of file trilinos_epetra_vector.cc.

◆ linfty_norm()

double Vector< Number >::linfty_norm ( ) const
overridevirtual

Return the maximum norm of the vector (i.e., the maximum absolute value among all entries and among all processors).

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 510 of file trilinos_epetra_vector.cc.

◆ add_and_dot()

double Vector< Number >::add_and_dot ( const double  a,
const VectorSpaceVector< double > &  V,
const VectorSpaceVector< double > &  W 
)
overridevirtual

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

this->add(a, V);
return_value = *this * W;

The reason this function exists is that this operation involves less memory transfer than calling the two functions separately. This method only needs to load three vectors, this, V, W, whereas calling separate methods means to load the calling vector this twice. Since most vector operations are memory transfer limited, this reduces the time by 25% (or 50% if W equals this).

The vectors need to have the same layout.

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}\).

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 523 of file trilinos_epetra_vector.cc.

◆ has_ghost_elements()

bool Vector< Number >::has_ghost_elements ( ) const
inline

This function always returns false and is present only for backward compatibility.

Definition at line 389 of file trilinos_epetra_vector.h.

◆ size()

Vector::size_type Vector< Number >::size ( ) const
overridevirtual

Return the global size of the vector, equal to the sum of the number of locally owned indices among all processors.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 535 of file trilinos_epetra_vector.cc.

◆ get_mpi_communicator()

MPI_Comm Vector< Number >::get_mpi_communicator ( ) const

Return the MPI communicator object in use with this object.

Definition at line 547 of file trilinos_epetra_vector.cc.

◆ locally_owned_elements()

IndexSet Vector< Number >::locally_owned_elements ( ) const
overridevirtual

Return an index set that describes which elements of this vector are owned by the current 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())

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 558 of file trilinos_epetra_vector.cc.

◆ trilinos_vector() [1/2]

const Epetra_FEVector & Vector< Number >::trilinos_vector ( ) const

Return a const reference to the underlying Trilinos Epetra_FEVector class.

Definition at line 592 of file trilinos_epetra_vector.cc.

◆ trilinos_vector() [2/2]

Epetra_FEVector & Vector< Number >::trilinos_vector ( )

Return a (modifiable) reference to the underlying Trilinos Epetra_FEVector class.

Definition at line 600 of file trilinos_epetra_vector.cc.

◆ print()

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

Prints the vector to the output stream out.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 608 of file trilinos_epetra_vector.cc.

◆ memory_consumption()

std::size_t Vector< Number >::memory_consumption ( ) const
overridevirtual

Return the memory consumption of this class in bytes.

Implements LinearAlgebra::VectorSpaceVector< double >.

Definition at line 646 of file trilinos_epetra_vector.cc.

◆ create_epetra_comm_pattern()

void Vector< Number >::create_epetra_comm_pattern ( const IndexSet source_index_set,
const MPI_Comm &  mpi_comm 
)
private

Create the CommunicationPattern for the communication between the IndexSet source_index_set and the current vector based on the communicator mpi_comm.

Definition at line 656 of file trilinos_epetra_vector.cc.

Member Data Documentation

◆ vector

std::unique_ptr<Epetra_FEVector> LinearAlgebra::EpetraWrappers::Vector::vector
private

Pointer to the actual Epetra vector object.

Definition at line 373 of file trilinos_epetra_vector.h.

◆ source_stored_elements

::IndexSet LinearAlgebra::EpetraWrappers::Vector::source_stored_elements
private

IndexSet of the elements of the last imported vector.

Definition at line 378 of file trilinos_epetra_vector.h.

◆ epetra_comm_pattern

std::shared_ptr<const CommunicationPattern> LinearAlgebra::EpetraWrappers::Vector::epetra_comm_pattern
private

CommunicationPattern for the communication between the source_stored_elements IndexSet and the current vector.

Definition at line 384 of file trilinos_epetra_vector.h.


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