Chaste  Release::2017.1
AbstractStaticLinearPdeSolver.hpp
1 
2 /*
3 
4 Copyright (c) 2005-2017, University of Oxford.
5 All rights reserved.
6 
7 University of Oxford means the Chancellor, Masters and Scholars of the
8 University of Oxford, having an administrative office at Wellington
9 Square, Oxford OX1 2JD, UK.
10 
11 This file is part of Chaste.
12 
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15  * Redistributions of source code must retain the above copyright notice,
16  this list of conditions and the following disclaimer.
17  * Redistributions in binary form must reproduce the above copyright notice,
18  this list of conditions and the following disclaimer in the documentation
19  and/or other materials provided with the distribution.
20  * Neither the name of the University of Oxford nor the names of its
21  contributors may be used to endorse or promote products derived from this
22  software without specific prior written permission.
23 
24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
28 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
30 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
33 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 
35 */
36 
37 #ifndef ABSTRACTSTATICLINEARPDESOLVER_HPP_
38 #define ABSTRACTSTATICLINEARPDESOLVER_HPP_
39 
40 #include "AbstractLinearPdeSolver.hpp"
41 
48 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM>
49 class AbstractStaticLinearPdeSolver : public AbstractLinearPdeSolver<ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM>
50 {
51 public:
52 
59  : AbstractLinearPdeSolver<ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM>(pMesh)
60  {
61  }
62 
69  Vec Solve(Vec initialGuess=nullptr);
70 };
71 
72 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM>
74 {
75  // Set up the linear system
76  this->InitialiseForSolve(initialGuess);
77 
78  // This method can be overloaded if necessary
79  this->PrepareForSetupLinearSystem(nullptr);
80 
81  // This method should be implemented by the concrete class
82  this->SetupLinearSystem(nullptr, true);
83 
84  this->FinaliseLinearSystem(nullptr);
85 
86  // Solve the linear system
87  Vec solution = this->mpLinearSystem->Solve(initialGuess);
88 
89  this->FollowingSolveLinearSystem(solution);
90 
91  return solution;
92 }
93 
94 #endif /*ABSTRACTSTATICLINEARPDESOLVER_HPP_*/
virtual void PrepareForSetupLinearSystem(Vec currentSolution)
Vec Solve(Vec lhsGuess=nullptr)
virtual void InitialiseForSolve(Vec initialSolution=nullptr)
virtual void FollowingSolveLinearSystem(Vec currentSolution)
AbstractStaticLinearPdeSolver(AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > *pMesh)
virtual void SetupLinearSystem(Vec currentSolution, bool computeMatrix)=0
virtual void FinaliseLinearSystem(Vec currentSolution)