Chaste  Release::3.4
DistributedVector.cpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #include "DistributedVector.hpp"
37 #include "DistributedVectorFactory.hpp"
38 
39 bool DistributedVector::IsGlobalIndexLocal(unsigned globalIndex)
40 {
41  return (mLo<=globalIndex && globalIndex<mHi);
42 }
43 
45  : mVec(vec),
46  mpFactory(pFactory),
47  mReadOnly(readOnly)
48 {
49  assert(pFactory != NULL);
50 
51  // Set local copies of problem size, etc.
52  mProblemSize = pFactory->GetProblemSize();
53  mLo = pFactory->GetLow();
54  mHi = pFactory->GetHigh();
55 
56  if (mReadOnly)
57  {
58 #if (PETSC_VERSION_MAJOR == 3 && PETSC_VERSION_MINOR >= 2) //PETSc 3.2 or later
59  // Request read-only access properly
60  VecGetArrayRead(vec, (const PetscScalar**)&mpVec);
61 #else
62  // Silently ignore the request and hope nothing breaks
63  VecGetArray(vec, &mpVec);
64 #endif
65  }
66  else
67  {
68  VecGetArray(vec, &mpVec);
69  }
70 
71  // Set mSizeMultiplier by reading the vec size.
72  PetscInt size;
73  VecGetSize(vec, &size);
75  assert ((mSizeMultiplier * mProblemSize) == (unsigned)size);
76 }
77 
78 double& DistributedVector::operator[](unsigned globalIndex) throw (DistributedVectorException)
79 {
80  assert(mSizeMultiplier == 1);
81  if (mLo<=globalIndex && globalIndex<mHi)
82  {
83  return mpVec[globalIndex - mLo];
84  }
86 }
87 
89 {
90  assert(mSizeMultiplier==1);
91  return mpVec[index.Local];
92 }
93 
95 {
96  assert(mReadOnly == false);
97  VecRestoreArray(mVec, &mpVec);
98 
99 #if (PETSC_VERSION_MAJOR == 3 && PETSC_VERSION_MINOR >= 2) //PETSc 3.2 or later
100 
103  VecGetArray(mVec, &mpVec);
104 #endif
105 
106 }
107 
108 // Iterator class
109 
111 {
112  return(Global != rOther.Global);
113 }
114 
116 {
117  Local++;
118  Global++;
119  return(*this);
120 }
121 
122 // Iterator creation
123 
125 {
126  Iterator index;
127  index.Local = 0;
128  index.Global = mLo;
129  return index;
130 }
131 
133 {
134  Iterator index;
135  index.Local = mHi-mLo;
136  index.Global = mHi;
137  return index;
138 }
DistributedVector(Vec vec, DistributedVectorFactory *pFactory, bool readOnly=false)
double & operator[](unsigned globalIndex)
bool operator!=(const Iterator &rOther)
bool IsGlobalIndexLocal(unsigned globalIndex)