Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractLinearPdeSolver.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 ABSTRACTLINEARPDESOLVER_HPP_
37#define ABSTRACTLINEARPDESOLVER_HPP_
38
39#include "LinearSystem.hpp"
40#include "BoundaryConditionsContainer.hpp"
41#include "AbstractTetrahedralMesh.hpp"
42#include "HeartEventHandler.hpp"
43
48template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM>
49class AbstractLinearPdeSolver : private boost::noncopyable
50{
51protected:
52
55
58
59public:
60
67 : mpLinearSystem(nullptr),
68 mpMesh(pMesh)
69 {
70 assert(pMesh!=nullptr);
71 }
72
77 {
79 {
80 delete mpLinearSystem;
81 }
82 }
83
93 virtual void InitialiseForSolve(Vec initialSolution = nullptr);
94
101 virtual void PrepareForSetupLinearSystem(Vec currentSolution)
102 {
103 }
104
112 virtual void FinaliseLinearSystem(Vec currentSolution)
113 {
114 }
115
125 virtual void FollowingSolveLinearSystem(Vec currentSolution)
126 {
127 }
128
140 virtual void SetupLinearSystem(Vec currentSolution, bool computeMatrix)=0;
141
146 {
147 return mpLinearSystem;
148 }
149};
150
151template <unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM>
153{
154 if (this->mpLinearSystem == nullptr)
155 {
156 unsigned preallocation = PROBLEM_DIM * mpMesh->CalculateMaximumNodeConnectivityPerProcess();
157
158 HeartEventHandler::BeginEvent(HeartEventHandler::COMMUNICATION);
159 if (initialSolution == nullptr)
160 {
161 /*
162 * Static problem, create linear system. The following ensures
163 * all the unknowns for a particular node are on the same processor.
164 */
165 Vec template_vec = mpMesh->GetDistributedVectorFactory()->CreateVec(PROBLEM_DIM);
166
167 this->mpLinearSystem = new LinearSystem(template_vec, preallocation);
168
169 PetscTools::Destroy(template_vec);
170 }
171 else
172 {
173 /*
174 * Use the current solution (ie the initial solution)
175 * as the template in the alternative constructor of
176 * LinearSystem. This is to avoid problems with VecScatter.
177 */
178 this->mpLinearSystem = new LinearSystem(initialSolution, preallocation);
179 }
180
181 HeartEventHandler::EndEvent(HeartEventHandler::COMMUNICATION);
182 }
183}
184
185#endif /*ABSTRACTLINEARPDESOLVER_HPP_*/
virtual void InitialiseForSolve(Vec initialSolution=nullptr)
AbstractLinearPdeSolver(AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > *pMesh)
virtual void FollowingSolveLinearSystem(Vec currentSolution)
AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > * mpMesh
virtual void PrepareForSetupLinearSystem(Vec currentSolution)
virtual void FinaliseLinearSystem(Vec currentSolution)
virtual void SetupLinearSystem(Vec currentSolution, bool computeMatrix)=0
static void Destroy(Vec &rVec)