ReplicatableVector Class Reference
#include <ReplicatableVector.hpp>
Public Member Functions | |
| ReplicatableVector () | |
| ReplicatableVector (Vec vec) | |
| ReplicatableVector (unsigned size) | |
| ~ReplicatableVector () | |
| unsigned | GetSize () |
| void | Resize (unsigned size) |
| double & | operator[] (unsigned index) |
| void | Replicate (unsigned lo, unsigned hi) |
| void | ReplicatePetscVector (Vec vec) |
Private Member Functions | |
| void | RemovePetscContext () |
Private Attributes | |
| double * | mpData |
| unsigned | mSize |
| VecScatter | mToAll |
| Vec | mReplicated |
Detailed Description
Helper class for replicating a PETSc vector.
Definition at line 38 of file ReplicatableVector.hpp.
Constructor & Destructor Documentation
| ReplicatableVector::ReplicatableVector | ( | ) |
Default constructor. Note that the vector will need to be resized before it can be used.
Definition at line 61 of file ReplicatableVector.cpp.
| ReplicatableVector::ReplicatableVector | ( | Vec | vec | ) |
Constructor taking in PETSc vector, which is immediately replicated into the internal data
- Parameters:
-
vec a PETSc vector
Definition at line 69 of file ReplicatableVector.cpp.
References ReplicatePetscVector().
| ReplicatableVector::ReplicatableVector | ( | unsigned | size | ) |
Constructor to make a vector of given size.
- Parameters:
-
size the size of the vector
Definition at line 78 of file ReplicatableVector.cpp.
References Resize().
| ReplicatableVector::~ReplicatableVector | ( | ) |
Default destructor. Remove PETSc context.
Definition at line 87 of file ReplicatableVector.cpp.
References RemovePetscContext().
Member Function Documentation
| unsigned ReplicatableVector::GetSize | ( | ) |
Return the size of the vector.
Definition at line 94 of file ReplicatableVector.cpp.
References mSize.
Referenced by AbstractFeCableIntegralAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, CAN_ASSEMBLE_VECTOR, CAN_ASSEMBLE_MATRIX, INTERPOLATION_LEVEL >::AssembleOnCableElement(), AbstractFeVolumeIntegralAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, CAN_ASSEMBLE_VECTOR, CAN_ASSEMBLE_MATRIX, INTERPOLATION_LEVEL >::AssembleOnElement(), AbstractFunctionalCalculator< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::Calculate(), Hdf5ToTxtConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToTxtConverter(), Replicate(), ReplicatePetscVector(), AbstractFeAssemblerCommon< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, CAN_ASSEMBLE_VECTOR, CAN_ASSEMBLE_MATRIX, INTERPOLATION_LEVEL >::SetCurrentSolution(), AbstractNonlinearElasticitySolver< DIM >::VectorSum(), Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Write(), and Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >::Write().
Access the vector.
- Parameters:
-
index the index of the vector to return
Definition at line 121 of file ReplicatableVector.cpp.
| void ReplicatableVector::RemovePetscContext | ( | ) | [private] |
Clear data. Used in resize method and destructor.
Definition at line 38 of file ReplicatableVector.cpp.
References mpData, mReplicated, and mToAll.
Referenced by Resize(), and ~ReplicatableVector().
Replicate this vector over all processes.
Each process knows its local part of the vector. This method shares that knowledge across all the processes.
- Parameters:
-
lo The start of our ownership range hi One past the end of our ownership range
Definition at line 129 of file ReplicatableVector.cpp.
References GetSize(), mpData, and ReplicatePetscVector().
Referenced by ExtendedBidomainTissue< SPACE_DIM >::ReplicateAdditionalCaches(), and AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::ReplicateCaches().
| void ReplicatableVector::ReplicatePetscVector | ( | Vec | vec | ) |
Replicate the given PETSc vector over all processes.
Each process knows its local part of the vector. This method shares that knowledge across all the processes, storing it in this object.
Our data vector will automatically be resized to fit the whole PETSc vector.
- Parameters:
-
vec The PETSc vector to replicate.
Definition at line 142 of file ReplicatableVector.cpp.
References GetSize(), mpData, mReplicated, mToAll, and Resize().
Referenced by AbstractFunctionalCalculator< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::Calculate(), Hdf5ToTxtConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToTxtConverter(), ReplicatableVector(), Replicate(), AbstractFeAssemblerCommon< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, CAN_ASSEMBLE_VECTOR, CAN_ASSEMBLE_MATRIX, INTERPOLATION_LEVEL >::SetCurrentSolution(), and Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Write().
| void ReplicatableVector::Resize | ( | unsigned | size | ) |
Resize the vector.
- Parameters:
-
size The number of elements to allocate memory for.
Definition at line 99 of file ReplicatableVector.cpp.
References mpData, mSize, RemovePetscContext(), and PetscTools::ReplicateException().
Referenced by AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::AbstractCardiacTissue(), ExtendedBidomainTissue< SPACE_DIM >::ExtendedBidomainTissue(), AbstractCardiacTissue< SPACE_DIM >::load(), ReplicatableVector(), and ReplicatePetscVector().
Member Data Documentation
double* ReplicatableVector::mpData [private] |
The wrapped PeTSc vector.
Definition at line 42 of file ReplicatableVector.hpp.
Referenced by operator[](), RemovePetscContext(), Replicate(), ReplicatePetscVector(), and Resize().
Vec ReplicatableVector::mReplicated [private] |
Vector to hold concentrated copy of replicated vector.
Definition at line 45 of file ReplicatableVector.hpp.
Referenced by RemovePetscContext(), and ReplicatePetscVector().
unsigned ReplicatableVector::mSize [private] |
The length of the vector.
Definition at line 43 of file ReplicatableVector.hpp.
Referenced by GetSize(), operator[](), and Resize().
VecScatter ReplicatableVector::mToAll [private] |
Variable holding information for replicating a PETSc vector.
Definition at line 44 of file ReplicatableVector.hpp.
Referenced by RemovePetscContext(), and ReplicatePetscVector().
The documentation for this class was generated from the following files:
- global/src/parallel/ReplicatableVector.hpp
- global/src/parallel/ReplicatableVector.cpp
