Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractFeAssemblerInterface.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 ABSTRACTFEASSEMBLERINTERFACE_HPP_
37#define ABSTRACTFEASSEMBLERINTERFACE_HPP_
38
39#include <cassert>
41#include "PetscTools.hpp"
42
50template <bool CAN_ASSEMBLE_VECTOR, bool CAN_ASSEMBLE_MATRIX>
51class AbstractFeAssemblerInterface : private boost::noncopyable
52{
53protected:
56
59
66
69
72
75
78
81
89 virtual void DoAssemble()=0;
90
91public:
92
97
105 void SetMatrixToAssemble(Mat& rMatToAssemble, bool zeroMatrixBeforeAssembly=true);
106
114 void SetVectorToAssemble(Vec& rVecToAssemble, bool zeroVectorBeforeAssembly);
115
119 void Assemble()
120 {
121 mAssembleMatrix = CAN_ASSEMBLE_MATRIX;
122 mAssembleVector = CAN_ASSEMBLE_VECTOR;
123 DoAssemble();
124 }
125
130 {
131 assert(CAN_ASSEMBLE_MATRIX);
132 mAssembleMatrix = true;
133 mAssembleVector = false;
134 DoAssemble();
135 }
136
141 {
142 assert(CAN_ASSEMBLE_VECTOR);
143 mAssembleMatrix = false;
144 mAssembleVector = true;
145 DoAssemble();
146 }
147
152 {
153 }
154};
155
156template <bool CAN_ASSEMBLE_VECTOR, bool CAN_ASSEMBLE_MATRIX>
158 : mVectorToAssemble(nullptr),
159 mMatrixToAssemble(nullptr),
160 mZeroMatrixBeforeAssembly(true),
161 mZeroVectorBeforeAssembly(true)
162{
163 assert(CAN_ASSEMBLE_VECTOR || CAN_ASSEMBLE_MATRIX);
164}
165
166template <bool CAN_ASSEMBLE_VECTOR, bool CAN_ASSEMBLE_MATRIX>
168{
169 assert(rMatToAssemble);
170 MatGetOwnershipRange(rMatToAssemble, &mOwnershipRangeLo, &mOwnershipRangeHi);
171
172 mMatrixToAssemble = rMatToAssemble;
173 mZeroMatrixBeforeAssembly = zeroMatrixBeforeAssembly;
174}
175
176template <bool CAN_ASSEMBLE_VECTOR, bool CAN_ASSEMBLE_MATRIX>
178{
179 assert(rVecToAssemble);
180 VecGetOwnershipRange(rVecToAssemble, &mOwnershipRangeLo, &mOwnershipRangeHi);
181
182 mVectorToAssemble = rVecToAssemble;
183 mZeroVectorBeforeAssembly = zeroVectorBeforeAssembly;
184}
185
186#endif // ABSTRACTFEASSEMBLERINTERFACE_HPP_
void SetMatrixToAssemble(Mat &rMatToAssemble, bool zeroMatrixBeforeAssembly=true)
void SetVectorToAssemble(Vec &rVecToAssemble, bool zeroVectorBeforeAssembly)
virtual void DoAssemble()=0