Public Member Functions | Private Member Functions | Private Attributes | List of all members
oomph::DoubleMultiVector Class Reference

A multi vector in the mathematical sense, initially developed for linear algebra type applications. If MPI then this multi vector can be distributed - its distribution is described by the LinearAlgebraDistribution object at Distribution_pt. Data is stored in a C-style pointer vector (double*) More...

#include <double_multi_vector.h>

+ Inheritance diagram for oomph::DoubleMultiVector:

Public Member Functions

 DoubleMultiVector ()
 Constructor for an uninitialized DoubleMultiVector. More...
 
 DoubleMultiVector (const unsigned &n_vector, const LinearAlgebraDistribution *const &dist_pt, const double &v=0.0)
 Constructor. Assembles a DoubleMultiVector consisting of n_vector vectors, each with a prescribed distribution. Additionally every entry can be set (with argument v - defaults to 0). More...
 
 DoubleMultiVector (const unsigned &n_vector, const LinearAlgebraDistribution &dist, const double &v=0.0)
 Constructor. Assembles a DoubleMultiVector consisting of n_vector vectors, each with a prescribed distribution. Additionally every entry can be set (with argument v - defaults to 0). More...
 
 DoubleMultiVector (const unsigned &n_vector, const DoubleMultiVector &old_vector, const double &initial_value=0.0)
 Constructor. Build a multivector using the same distribution of the input vector with n_vector columns and initialised to the value v. More...
 
 DoubleMultiVector (const DoubleMultiVector &old_vector, const std::vector< int > &index, const bool &deep_copy=true)
 Constructor that builds a multivector from selected columns of the input multivector. The boolean controls whether it is a shallow or deep copy (default deep) More...
 
 DoubleMultiVector (const DoubleMultiVector &old_vector, const Teuchos::Range1D &index, const bool &deep_copy=true)
 Constructor that builds a multivector from selected columns of the input multivector and the provided range. The optional boolean specifies whether it is a shallow or deep copy. The default is that it is a deep copy. More...
 
 DoubleMultiVector (const DoubleMultiVector &new_vector)
 Copy constructor. More...
 
 ~DoubleMultiVector ()
 Destructor - just calls this->clear() to delete the distribution and data. More...
 
void operator= (const DoubleMultiVector &old_vector)
 assignment operator (deep copy) More...
 
unsigned nvector () const
 Return the number of vectors. More...
 
void shallow_build (const DoubleMultiVector &old_vector)
 Provide a (shallow) copy of the old vector. More...
 
void shallow_build (const unsigned &n_vector, const LinearAlgebraDistribution &dist)
 Build the storage for pointers to vectors with a given distribution, but do not populate the pointers. More...
 
void shallow_build (const unsigned &n_vector, const LinearAlgebraDistribution *const &dist_pt)
 Build the storage for pointers to vectors with a given distribution, but do not populate the pointers. More...
 
void build (const DoubleMultiVector &old_vector)
 Provides a (deep) copy of the old_vector. More...
 
void build (const unsigned &n_vector, const LinearAlgebraDistribution &dist, const double &initial_value=0.0)
 Assembles a DoubleMultiVector with n_vector vectors, a distribution dist, if v is specified each element is set to v, otherwise each element is set to 0.0. More...
 
void build (const unsigned &n_vector, const LinearAlgebraDistribution *const &dist_pt, const double &initial_value=0.0)
 Assembles a DoubleMultiVector with n_vector vectors, each with a distribution dist, if v is specified each element is set to v, otherwise each element is set to 0.0. More...
 
void initialise (const double &initial_value)
 initialise the whole vector with value v More...
 
void clear ()
 initialise the vector with coefficient from the vector v. Note: The vector v must be of length More...
 
bool built () const
 
void redistribute (const LinearAlgebraDistribution *const &dist_pt)
 Allows are external data to be used by this vector. WARNING: The size of the external data must correspond to the LinearAlgebraDistribution dist_pt argument. More...
 
double & operator() (int v, int i) const
 [] access function to the (local) values of the v-th vector More...
 
bool operator== (const DoubleMultiVector &vec)
 == operator More...
 
void operator+= (DoubleMultiVector vec)
 += operator More...
 
void operator-= (DoubleMultiVector vec)
 -= operator More...
 
void operator*= (const double &scalar_value)
 Multiply by a scalar. More...
 
double ** values ()
 access function to the underlying values More...
 
double ** values () const
 access function to the underlying values (const version) More...
 
double * values (const unsigned &i)
 access function to the i-th vector's data More...
 
double * values (const unsigned &i) const
 access function to the i-th vector's data (const version) More...
 
DoubleVectordoublevector (const unsigned &i)
 access to the DoubleVector representatoin More...
 
const DoubleVectordoublevector (const unsigned &i) const
 access to the DoubleVector representation (const version) More...
 
void output (std::ostream &outfile) const
 output the contents of the vector More...
 
void output (std::string filename)
 output the contents of the vector More...
 
void dot (const DoubleMultiVector &vec, std::vector< double > &result) const
 compute the 2 norm of this vector More...
 
void norm (std::vector< double > &result) const
 compute the 2 norm of this vector More...
 
- Public Member Functions inherited from oomph::DistributableLinearAlgebraObject
 DistributableLinearAlgebraObject ()
 Default constructor - create a distribution. More...
 
 DistributableLinearAlgebraObject (const DistributableLinearAlgebraObject &matrix)
 Broken copy constructor. More...
 
void operator= (const DistributableLinearAlgebraObject &)
 Broken assignment operator. More...
 
virtual ~DistributableLinearAlgebraObject ()
 Destructor. More...
 
LinearAlgebraDistributiondistribution_pt () const
 access to the LinearAlgebraDistribution More...
 
unsigned nrow () const
 access function to the number of global rows. More...
 
unsigned nrow_local () const
 access function for the num of local rows on this processor. More...
 
unsigned nrow_local (const unsigned &p) const
 access function for the num of local rows on this processor. More...
 
unsigned first_row () const
 access function for the first row on this processor More...
 
unsigned first_row (const unsigned &p) const
 access function for the first row on this processor More...
 
bool distributed () const
 distribution is serial or distributed More...
 
bool distribution_built () const
 
void build_distribution (const LinearAlgebraDistribution *const dist_pt)
 setup the distribution of this distributable linear algebra object More...
 
void build_distribution (const LinearAlgebraDistribution &dist)
 setup the distribution of this distributable linear algebra object More...
 

Private Member Functions

void setup_doublevector_representation ()
 compute the A-norm using the matrix at matrix_pt More...
 

Private Attributes

double ** Values
 
unsigned Nvector
 The number of vectors. More...
 
bool Internal_values
 Boolean flag to indicate whether the vector's data (values_pt) is owned by this vector. More...
 
bool Built
 indicates that the vector has been built and is usable More...
 
Vector< DoubleVectorInternal_doublevector
 Need a vector of DoubleVectors to interface with our linear solvers. More...
 

Additional Inherited Members

- Protected Member Functions inherited from oomph::DistributableLinearAlgebraObject
void clear_distribution ()
 clear the distribution of this distributable linear algebra object More...
 

Detailed Description

A multi vector in the mathematical sense, initially developed for linear algebra type applications. If MPI then this multi vector can be distributed - its distribution is described by the LinearAlgebraDistribution object at Distribution_pt. Data is stored in a C-style pointer vector (double*)

Definition at line 60 of file double_multi_vector.h.

Constructor & Destructor Documentation

oomph::DoubleMultiVector::DoubleMultiVector ( )
inline

Constructor for an uninitialized DoubleMultiVector.

Definition at line 66 of file double_multi_vector.h.

oomph::DoubleMultiVector::DoubleMultiVector ( const unsigned &  n_vector,
const LinearAlgebraDistribution *const &  dist_pt,
const double &  v = 0.0 
)
inline

Constructor. Assembles a DoubleMultiVector consisting of n_vector vectors, each with a prescribed distribution. Additionally every entry can be set (with argument v - defaults to 0).

Definition at line 73 of file double_multi_vector.h.

References build(), and setup_doublevector_representation().

oomph::DoubleMultiVector::DoubleMultiVector ( const unsigned &  n_vector,
const LinearAlgebraDistribution dist,
const double &  v = 0.0 
)
inline

Constructor. Assembles a DoubleMultiVector consisting of n_vector vectors, each with a prescribed distribution. Additionally every entry can be set (with argument v - defaults to 0).

Definition at line 86 of file double_multi_vector.h.

References build(), and setup_doublevector_representation().

oomph::DoubleMultiVector::DoubleMultiVector ( const unsigned &  n_vector,
const DoubleMultiVector old_vector,
const double &  initial_value = 0.0 
)
inline

Constructor. Build a multivector using the same distribution of the input vector with n_vector columns and initialised to the value v.

Definition at line 98 of file double_multi_vector.h.

References build(), oomph::DistributableLinearAlgebraObject::distribution_pt(), and setup_doublevector_representation().

oomph::DoubleMultiVector::DoubleMultiVector ( const DoubleMultiVector old_vector,
const std::vector< int > &  index,
const bool &  deep_copy = true 
)
inline

Constructor that builds a multivector from selected columns of the input multivector. The boolean controls whether it is a shallow or deep copy (default deep)

Definition at line 110 of file double_multi_vector.h.

References build(), oomph::CRDoubleMatrixHelpers::deep_copy(), oomph::DistributableLinearAlgebraObject::distribution_pt(), i, oomph::DistributableLinearAlgebraObject::nrow_local(), setup_doublevector_representation(), shallow_build(), values(), and Values.

oomph::DoubleMultiVector::DoubleMultiVector ( const DoubleMultiVector old_vector,
const Teuchos::Range1D &  index,
const bool &  deep_copy = true 
)
inline

Constructor that builds a multivector from selected columns of the input multivector and the provided range. The optional boolean specifies whether it is a shallow or deep copy. The default is that it is a deep copy.

Definition at line 149 of file double_multi_vector.h.

References build(), oomph::CRDoubleMatrixHelpers::deep_copy(), oomph::DistributableLinearAlgebraObject::distribution_pt(), i, oomph::DistributableLinearAlgebraObject::nrow_local(), setup_doublevector_representation(), shallow_build(), values(), and Values.

oomph::DoubleMultiVector::DoubleMultiVector ( const DoubleMultiVector new_vector)
inline

Copy constructor.

Definition at line 189 of file double_multi_vector.h.

References build(), and setup_doublevector_representation().

oomph::DoubleMultiVector::~DoubleMultiVector ( )
inline

Destructor - just calls this->clear() to delete the distribution and data.

Definition at line 199 of file double_multi_vector.h.

References clear().

Member Function Documentation

void oomph::DoubleMultiVector::build ( const DoubleMultiVector old_vector)
inline
void oomph::DoubleMultiVector::build ( const unsigned &  n_vector,
const LinearAlgebraDistribution dist,
const double &  initial_value = 0.0 
)
inline

Assembles a DoubleMultiVector with n_vector vectors, a distribution dist, if v is specified each element is set to v, otherwise each element is set to 0.0.

Definition at line 311 of file double_multi_vector.h.

References build().

void oomph::DoubleMultiVector::build ( const unsigned &  n_vector,
const LinearAlgebraDistribution *const &  dist_pt,
const double &  initial_value = 0.0 
)
inline

Assembles a DoubleMultiVector with n_vector vectors, each with a distribution dist, if v is specified each element is set to v, otherwise each element is set to 0.0.

Definition at line 321 of file double_multi_vector.h.

References oomph::DistributableLinearAlgebraObject::build_distribution(), oomph::LinearAlgebraDistribution::built(), Built, clear(), i, Internal_values, oomph::DistributableLinearAlgebraObject::nrow_local(), Nvector, values(), and Values.

bool oomph::DoubleMultiVector::built ( ) const
inline

Definition at line 408 of file double_multi_vector.h.

References Built.

Referenced by dot(), norm(), operator+=(), operator-=(), and operator==().

void oomph::DoubleMultiVector::clear ( )
inline

initialise the vector with coefficient from the vector v. Note: The vector v must be of length

wipes the DoubleVector

Definition at line 385 of file double_multi_vector.h.

References Built, oomph::DistributableLinearAlgebraObject::clear_distribution(), Internal_values, and Values.

Referenced by build(), shallow_build(), and ~DoubleMultiVector().

void oomph::DoubleMultiVector::dot ( const DoubleMultiVector vec,
std::vector< double > &  result 
) const
inline
DoubleVector& oomph::DoubleMultiVector::doublevector ( const unsigned &  i)
inline

access to the DoubleVector representatoin

Definition at line 674 of file double_multi_vector.h.

References i, and Internal_doublevector.

Referenced by oomph::ProblemBasedShiftInvertOperator::apply().

const DoubleVector& oomph::DoubleMultiVector::doublevector ( const unsigned &  i) const
inline

access to the DoubleVector representation (const version)

Definition at line 678 of file double_multi_vector.h.

References i, and Internal_doublevector.

void oomph::DoubleMultiVector::initialise ( const double &  initial_value)
inline

initialise the whole vector with value v

Definition at line 362 of file double_multi_vector.h.

References Built, i, oomph::DistributableLinearAlgebraObject::nrow_local(), Nvector, and Values.

Referenced by Anasazi::MultiVecTraits< double, oomph::DoubleMultiVector >::MvInit().

void oomph::DoubleMultiVector::norm ( std::vector< double > &  result) const
inline
unsigned oomph::DoubleMultiVector::nvector ( ) const
inline
double& oomph::DoubleMultiVector::operator() ( int  v,
int  i 
) const
inline

[] access function to the (local) values of the v-th vector

Definition at line 476 of file double_multi_vector.h.

References i, oomph::DistributableLinearAlgebraObject::nrow_local(), Nvector, and Values.

void oomph::DoubleMultiVector::operator*= ( const double &  scalar_value)
inline
void oomph::DoubleMultiVector::operator+= ( DoubleMultiVector  vec)
inline
void oomph::DoubleMultiVector::operator-= ( DoubleMultiVector  vec)
inline
void oomph::DoubleMultiVector::operator= ( const DoubleMultiVector old_vector)
inline

assignment operator (deep copy)

Definition at line 205 of file double_multi_vector.h.

References build(), and setup_doublevector_representation().

bool oomph::DoubleMultiVector::operator== ( const DoubleMultiVector vec)
inline
void oomph::DoubleMultiVector::output ( std::ostream &  outfile) const
inline
void oomph::DoubleMultiVector::output ( std::string  filename)
inline

output the contents of the vector

Definition at line 771 of file double_multi_vector.h.

References output().

void oomph::DoubleMultiVector::redistribute ( const LinearAlgebraDistribution *const &  dist_pt)

Allows are external data to be used by this vector. WARNING: The size of the external data must correspond to the LinearAlgebraDistribution dist_pt argument.

  1. When a rebuild method is called new internal values are created.
  2. It is not possible to redistribute(...) a vector with external values .
  3. External values are only deleted by this vector if delete_external_values = true. Allows are external data to be used by this vector. WARNING: The size of the external data must correspond to the distribution of this vector.
  1. When a rebuild method is called new internal values are created.
  2. It is not possible to redistribute(...) a vector with external values .
  3. External values are only deleted by this vector if delete_external_values = true. The contents of the vector are redistributed to match the new distribution. In a non-MPI rebuild this method works, but does nothing. NOTE 1: The current distribution and the new distribution must have the same number of global rows. NOTE 2: The current distribution and the new distribution must have the same Communicator.

The contents of the vector are redistributed to match the new distribution. In a non-MPI rebuild this method works, but does nothing. NOTE 1: The current distribution and the new distribution must have the same number of global rows. NOTE 2: The current distribution and the new distribution must have the same Communicator.

Definition at line 41 of file double_multi_vector.cc.

References oomph::DistributableLinearAlgebraObject::build_distribution(), oomph::LinearAlgebraDistribution::communicator_pt(), oomph::LinearAlgebraDistribution::distributed(), oomph::DistributableLinearAlgebraObject::distributed(), oomph::DistributableLinearAlgebraObject::distribution_pt(), oomph::LinearAlgebraDistribution::first_row(), oomph::DistributableLinearAlgebraObject::first_row(), i, Internal_values, oomph::LinearAlgebraDistribution::nrow(), oomph::DistributableLinearAlgebraObject::nrow(), oomph::LinearAlgebraDistribution::nrow_local(), oomph::DistributableLinearAlgebraObject::nrow_local(), Nvector, setup_doublevector_representation(), values(), and Values.

void oomph::DoubleMultiVector::setup_doublevector_representation ( )
inlineprivate

compute the A-norm using the matrix at matrix_pt

Setup the doublevector representation

Definition at line 934 of file double_multi_vector.h.

References oomph::DistributableLinearAlgebraObject::distribution_pt(), Internal_doublevector, nvector(), and values().

Referenced by DoubleMultiVector(), operator=(), and redistribute().

void oomph::DoubleMultiVector::shallow_build ( const DoubleMultiVector old_vector)
inline
void oomph::DoubleMultiVector::shallow_build ( const unsigned &  n_vector,
const LinearAlgebraDistribution dist 
)
inline

Build the storage for pointers to vectors with a given distribution, but do not populate the pointers.

Definition at line 241 of file double_multi_vector.h.

References shallow_build().

void oomph::DoubleMultiVector::shallow_build ( const unsigned &  n_vector,
const LinearAlgebraDistribution *const &  dist_pt 
)
inline

Build the storage for pointers to vectors with a given distribution, but do not populate the pointers.

Definition at line 250 of file double_multi_vector.h.

References oomph::DistributableLinearAlgebraObject::build_distribution(), oomph::LinearAlgebraDistribution::built(), Built, clear(), Internal_values, Nvector, and Values.

double** oomph::DoubleMultiVector::values ( )
inline

access function to the underlying values

Definition at line 662 of file double_multi_vector.h.

References Values.

Referenced by build(), dot(), DoubleMultiVector(), operator+=(), operator-=(), operator==(), redistribute(), setup_doublevector_representation(), and shallow_build().

double** oomph::DoubleMultiVector::values ( ) const
inline

access function to the underlying values (const version)

Definition at line 665 of file double_multi_vector.h.

References Values.

double* oomph::DoubleMultiVector::values ( const unsigned &  i)
inline

access function to the i-th vector's data

Definition at line 668 of file double_multi_vector.h.

References i, and Values.

double* oomph::DoubleMultiVector::values ( const unsigned &  i) const
inline

access function to the i-th vector's data (const version)

Definition at line 671 of file double_multi_vector.h.

References i, and Values.

Member Data Documentation

bool oomph::DoubleMultiVector::Built
private

indicates that the vector has been built and is usable

Definition at line 958 of file double_multi_vector.h.

Referenced by build(), built(), clear(), initialise(), and shallow_build().

Vector<DoubleVector> oomph::DoubleMultiVector::Internal_doublevector
private

Need a vector of DoubleVectors to interface with our linear solvers.

Definition at line 961 of file double_multi_vector.h.

Referenced by doublevector(), and setup_doublevector_representation().

bool oomph::DoubleMultiVector::Internal_values
private

Boolean flag to indicate whether the vector's data (values_pt) is owned by this vector.

Definition at line 955 of file double_multi_vector.h.

Referenced by build(), clear(), redistribute(), and shallow_build().

unsigned oomph::DoubleMultiVector::Nvector
private

The number of vectors.

Definition at line 951 of file double_multi_vector.h.

Referenced by build(), initialise(), nvector(), operator()(), redistribute(), and shallow_build().

double** oomph::DoubleMultiVector::Values
private

the local data, need a pointer to a pointer so that the individual vectors can be extracted

Definition at line 948 of file double_multi_vector.h.

Referenced by build(), clear(), dot(), DoubleMultiVector(), initialise(), norm(), operator()(), operator*=(), operator+=(), operator-=(), operator==(), output(), redistribute(), shallow_build(), and values().


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