Chaste Commit::ca8ccdedf819b6e02855bc0e8e6f50bdecbc5208
PetscVecTools.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef _PETSCVECTOOLS_HPP_
37#define _PETSCVECTOOLS_HPP_
38
39#include "UblasVectorInclude.hpp" // needs to be 'first'
40
41#include <petscvec.h>
42
47{
48public:
49
55 static void Finalise(Vec vector);
56
62 static void Display(Vec vector);
63
69 static void Zero(Vec vector);
70
78 static void SetElement(Vec vector, PetscInt row, double value);
79
87 static void AddToElement(Vec vector, PetscInt row, double value);
88
94 static unsigned GetSize(Vec vector);
95
103 static void GetOwnershipRange(Vec vector, PetscInt& lo, PetscInt& hi);
104
112 static double GetElement(Vec vector, PetscInt row);
113
121 static void AddScaledVector(Vec y, Vec x, double scaleFactor);
122
128 static void Scale(Vec vector, double scaleFactor);
129
138 static void WAXPY(Vec w, double a, Vec x, Vec y);
139
150 template<size_t VECTOR_SIZE>
151 static void AddMultipleValues(Vec vector, unsigned* vectorIndices, c_vector<double, VECTOR_SIZE>& smallVector)
152 {
153 PetscInt indices_owned[VECTOR_SIZE];
154 PetscInt num_indices_owned = 0;
155 PetscInt global_row;
156 PetscInt lo, hi;
157 GetOwnershipRange(vector, lo, hi);
158
159 for (unsigned row = 0; row<VECTOR_SIZE; row++)
160 {
161 global_row = vectorIndices[row];
162 if (global_row >=lo && global_row <hi)
163 {
164 indices_owned[num_indices_owned++] = global_row;
165 }
166 }
167
168 if (num_indices_owned == VECTOR_SIZE)
169 {
170 VecSetValues(vector,
171 num_indices_owned,
172 indices_owned,
173 smallVector.data(),
174 ADD_VALUES);
175 }
176 else
177 {
178 /*
179 * We need continuous data, if some of the rows do not belong
180 * to the processor their values are not passed to VecSetValues.
181 */
182 double values[VECTOR_SIZE];
183 unsigned num_values_owned = 0;
184
185 for (unsigned row = 0; row<VECTOR_SIZE; row++)
186 {
187 global_row = vectorIndices[row];
188 if (global_row >= lo && global_row < hi)
189 {
190 values[num_values_owned++] = smallVector(row);
191 }
192 }
193
194 VecSetValues(vector,
195 num_indices_owned,
196 indices_owned,
197 values,
198 ADD_VALUES);
199 }
200 }
201
210 static void SetupInterleavedVectorScatterGather(Vec interleavedVec, VecScatter& rFirstVariableScatterContext, VecScatter& rSecondVariableScatterContext);
211
221 static void DoInterleavedVecScatter(Vec interleavedVec, VecScatter firstVariableScatterContext, Vec firstVariableVec, VecScatter secondVariableScatterContext, Vec secondVariableVec);
222
232 static void DoInterleavedVecGather(Vec interleavedVec, VecScatter firstVariableScatterContext, Vec firstVariableVec, VecScatter secondVariableScatterContext, Vec secondVariableVec);
233};
234
235#endif //_PETSCVECTOOLS_HPP_
static double GetElement(Vec vector, PetscInt row)
static void DoInterleavedVecScatter(Vec interleavedVec, VecScatter firstVariableScatterContext, Vec firstVariableVec, VecScatter secondVariableScatterContext, Vec secondVariableVec)
static void WAXPY(Vec w, double a, Vec x, Vec y)
static void GetOwnershipRange(Vec vector, PetscInt &lo, PetscInt &hi)
static void DoInterleavedVecGather(Vec interleavedVec, VecScatter firstVariableScatterContext, Vec firstVariableVec, VecScatter secondVariableScatterContext, Vec secondVariableVec)
static void AddMultipleValues(Vec vector, unsigned *vectorIndices, c_vector< double, VECTOR_SIZE > &smallVector)
static void SetupInterleavedVectorScatterGather(Vec interleavedVec, VecScatter &rFirstVariableScatterContext, VecScatter &rSecondVariableScatterContext)
static void Scale(Vec vector, double scaleFactor)
static void AddScaledVector(Vec y, Vec x, double scaleFactor)
static void AddToElement(Vec vector, PetscInt row, double value)
static void Finalise(Vec vector)
static unsigned GetSize(Vec vector)
static void Display(Vec vector)
static void SetElement(Vec vector, PetscInt row, double value)
static void Zero(Vec vector)