Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractBidomainSolver.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 ABSTRACTBIDOMAINSOLVER_HPP_
37#define ABSTRACTBIDOMAINSOLVER_HPP_
38
39#include "AbstractDynamicLinearPdeSolver.hpp"
40#include "BidomainTissue.hpp"
41#include "HeartConfig.hpp"
42
48template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
49class AbstractBidomainSolver : public AbstractDynamicLinearPdeSolver<ELEMENT_DIM,SPACE_DIM,2>
50{
51protected:
54
57
60
63
66
70 std::vector<unsigned> mFixedExtracellularPotentialNodes;
71
78
85 void InitialiseForSolve(Vec initialSolution);
86
98 virtual void CheckCompatibilityCondition();
99
107 void PrepareForSetupLinearSystem(Vec existingSolution);
108
125 virtual void FinaliseLinearSystem(Vec existingSolution);
126
133 virtual Vec GenerateNullBasis() const;
134
148 void FinaliseForBath(bool computeMatrix, bool computeVector);
149
150public:
159 AbstractBidomainSolver(bool bathSimulation,
163
167 virtual ~AbstractBidomainSolver();
168
179 void SetFixedExtracellularPotentialNodes(std::vector<unsigned> fixedExtracellularPotentialNodes);
180
187 void SetRowForAverageOfPhiZeroed(unsigned rowMeanPhiEZero);
188
196
203 {
204 assert(pBcc);
206 // Note, in SetupLinearSystem()
207 // neumann_assembler->ResetBoundaryConditionsContainer(mpBcc)
208 // MUST be called every timestep, in case the bcc was reset.
209 }
210};
211
212#endif /*ABSTRACTBIDOMAINSOLVER_HPP_*/
void ResetBoundaryConditionsContainer(BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, 2 > *pBcc)
void InitialiseForSolve(Vec initialSolution)
virtual Vec GenerateNullBasis() const
void SetRowForAverageOfPhiZeroed(unsigned rowMeanPhiEZero)
void FinaliseForBath(bool computeMatrix, bool computeVector)
void SetFixedExtracellularPotentialNodes(std::vector< unsigned > fixedExtracellularPotentialNodes)
BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, 2 > * GetBoundaryConditions()
BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, 2 > * mpBoundaryConditions
std::vector< unsigned > mFixedExtracellularPotentialNodes
virtual void FinaliseLinearSystem(Vec existingSolution)
void PrepareForSetupLinearSystem(Vec existingSolution)
BidomainTissue< SPACE_DIM > * mpBidomainTissue