Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
ExtendedBidomainSolver.cpp
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
37#include "ExtendedBidomainSolver.hpp"
38#include "ExtendedBidomainMassMatrixAssembler.hpp"
39#include "ExtendedBidomainAssembler.hpp"
40
41template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
43{
44 if (this->mpLinearSystem != NULL)
45 {
46 return;
47 }
49
50 // initialise matrix-based RHS vector and matrix, and use the linear
51 // system rhs as a template
52 Vec& r_template = this->mpLinearSystem->rGetRhsVector();
53 VecDuplicate(r_template, &mVecForConstructingRhs);
54 PetscInt ownership_range_lo;
55 PetscInt ownership_range_hi;
56 VecGetOwnershipRange(r_template, &ownership_range_lo, &ownership_range_hi);
57 PetscInt local_size = ownership_range_hi - ownership_range_lo;
58 PetscTools::SetupMat(mMassMatrix, 3*this->mpMesh->GetNumNodes(), 3*this->mpMesh->GetNumNodes(),
59 3*this->mpMesh->CalculateMaximumNodeConnectivityPerProcess(),
60 local_size, local_size);
61}
62
63template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
65 Vec currentSolution,
66 bool computeMatrix)
67{
68 assert(this->mpLinearSystem->rGetLhsMatrix() != NULL);
69 assert(this->mpLinearSystem->rGetRhsVector() != NULL);
70 assert(currentSolution != NULL);
71
73 // set up LHS matrix (and mass matrix)
75 if (computeMatrix)
76 {
77 mpExtendedBidomainAssembler->SetMatrixToAssemble(this->mpLinearSystem->rGetLhsMatrix());
78 mpExtendedBidomainAssembler->AssembleMatrix();
79
80 // the ExtendedBidomainMassMatrixAssembler deals with the mass matrix
81 // for both bath and nonbath problems
82 assert(SPACE_DIM==ELEMENT_DIM);
83 ExtendedBidomainMassMatrixAssembler<SPACE_DIM> mass_matrix_assembler(this->mpMesh);
84 mass_matrix_assembler.SetMatrixToAssemble(mMassMatrix);
85 mass_matrix_assembler.Assemble();
86
87 this->mpLinearSystem->SwitchWriteModeLhsMatrix();
88 PetscMatTools::Finalise(mMassMatrix);
89 }
90
91
92 HeartEventHandler::BeginEvent(HeartEventHandler::ASSEMBLE_RHS);
93
95 // Set up z in b=Mz
97 DistributedVectorFactory* p_factory = this->mpMesh->GetDistributedVectorFactory();
98
99 // get bidomain parameters
100 double Am1 = this->mpExtendedBidomainTissue->GetAmFirstCell();
101 double Am2 = this->mpExtendedBidomainTissue->GetAmSecondCell();
102 double AmGap = this->mpExtendedBidomainTissue->GetAmGap();
103 double Cm1 = this->mpExtendedBidomainTissue->GetCmFirstCell();
104 double Cm2 = this->mpExtendedBidomainTissue->GetCmSecondCell();
105
106 // dist stripe for the current Voltage
107 DistributedVector distributed_current_solution = p_factory->CreateDistributedVector(currentSolution);
108 DistributedVector::Stripe distributed_current_solution_v_first_cell(distributed_current_solution, 0);
109 DistributedVector::Stripe distributed_current_solution_v_second_cell(distributed_current_solution, 1);
110 DistributedVector::Stripe distributed_current_solution_phi_e(distributed_current_solution, 2);
111
112 // dist stripe for z
113 DistributedVector dist_vec_matrix_based = p_factory->CreateDistributedVector(mVecForConstructingRhs);
114 DistributedVector::Stripe dist_vec_matrix_based_v_first_cell(dist_vec_matrix_based, 0);
115 DistributedVector::Stripe dist_vec_matrix_based_v_second_cell(dist_vec_matrix_based, 1);
116 DistributedVector::Stripe dist_vec_matrix_based_phi_e(dist_vec_matrix_based, 2);
117
118 for (DistributedVector::Iterator index = dist_vec_matrix_based.Begin();
119 index!= dist_vec_matrix_based.End();
120 ++index)
121 {
122 double V_first_cell = distributed_current_solution_v_first_cell[index];
123 double V_second_Cell = distributed_current_solution_v_second_cell[index];
124
125 double i_ionic_first_cell = this->mpExtendedBidomainTissue->rGetIionicCacheReplicated()[index.Global];
126 double i_ionic_second_cell = this->mpExtendedBidomainTissue->rGetIionicCacheReplicatedSecondCell()[index.Global];
127 double intracellular_stimulus_first_cell = this->mpExtendedBidomainTissue->rGetIntracellularStimulusCacheReplicated()[index.Global];
128 double intracellular_stimulus_second_cell = this->mpExtendedBidomainTissue->rGetIntracellularStimulusCacheReplicatedSecondCell()[index.Global];
129 double extracellular_stimulus = this->mpExtendedBidomainTissue->rGetExtracellularStimulusCacheReplicated()[index.Global];
130 double g_gap = this->mpExtendedBidomainTissue->rGetGgapCacheReplicated()[index.Global];
131 double delta_t = PdeSimulationTime::GetPdeTimeStep();
132 dist_vec_matrix_based_v_first_cell[index] = Am1*Cm1*V_first_cell/delta_t - Am1*i_ionic_first_cell + AmGap*g_gap*(V_second_Cell - V_first_cell) - intracellular_stimulus_first_cell;
133 dist_vec_matrix_based_v_second_cell[index] = Am2*Cm2*V_second_Cell/delta_t - Am2*i_ionic_second_cell + AmGap*g_gap*(V_first_cell - V_second_Cell) - intracellular_stimulus_second_cell;
134
135 if (this->mpExtendedBidomainTissue->HasTheUserSuppliedExtracellularStimulus() )
136 {
137 assert((fabs(intracellular_stimulus_first_cell) < 1e-12)
138 && (fabs(intracellular_stimulus_second_cell) < 1e-12));
144 dist_vec_matrix_based_phi_e[index] = -extracellular_stimulus;
145 }
146 else
147 {
148 dist_vec_matrix_based_phi_e[index] = 0.0;
149 }
150 }
151
152
153 dist_vec_matrix_based.Restore();
154
156 // b = Mz
158
159 MatMult(mMassMatrix, mVecForConstructingRhs, this->mpLinearSystem->rGetRhsVector());
160
161 // assembling RHS is not finished yet, as Neumann bcs are added below, but
162 // the event will be begun again inside mpExtendedBidomainAssembler->AssembleVector();
163 HeartEventHandler::EndEvent(HeartEventHandler::ASSEMBLE_RHS);
164
166 // apply Neumann boundary conditions
168 mpExtendedBidomainNeumannSurfaceTermAssembler->ResetBoundaryConditionsContainer(this->mpBoundaryConditions); // as the BCC can change
169 mpExtendedBidomainNeumannSurfaceTermAssembler->SetVectorToAssemble(this->mpLinearSystem->rGetRhsVector(), false/*don't zero vector!*/);
170 mpExtendedBidomainNeumannSurfaceTermAssembler->AssembleVector();
171
172 this->mpLinearSystem->FinaliseRhsVector();
173
174 this->mpBoundaryConditions->ApplyDirichletToLinearProblem(*(this->mpLinearSystem), computeMatrix);
175
176 if (computeMatrix)
177 {
178 this->mpLinearSystem->FinaliseLhsMatrix();
179 }
180 this->mpLinearSystem->FinaliseRhsVector();
181}
182
183template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
185 bool bathSimulation,
189 : AbstractExtendedBidomainSolver<ELEMENT_DIM,SPACE_DIM>(bathSimulation,pMesh,pTissue,pBoundaryConditions)
190{
191 // Tell Tissue there's no need to replicate ionic caches
192 pTissue->SetCacheReplication(false);
194
195 // create assembler
196 if (this->mBathSimulation)
197 {
198 //this->mpExtendedExtendedBidomainAssembler = new ExtendedExtendedBidomainWithBathAssembler<ELEMENT_DIM,SPACE_DIM>(this->mpMesh,this->mpExtendedExtendedBidomainTissue,this->mDt);
199 EXCEPTION("Bath simulations are not yet supported for extended bidomain problems");
200 }
201 else
202 {
204 }
205
207
208}
209
210template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
212{
213 delete mpExtendedBidomainAssembler;
214 delete mpExtendedBidomainNeumannSurfaceTermAssembler;
215
216 if (mVecForConstructingRhs)
217 {
218 PetscTools::Destroy(mVecForConstructingRhs);
219 PetscTools::Destroy(mMassMatrix);
220 }
221}
222
223// Explicit instantiation
224template class ExtendedBidomainSolver<1,1>;
225template class ExtendedBidomainSolver<2,2>;
226template class ExtendedBidomainSolver<3,3>;
#define EXCEPTION(message)
void SetCacheReplication(bool doCacheReplication)
void SetMatrixToAssemble(Mat &rMatToAssemble, bool zeroMatrixBeforeAssembly=true)
AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > * mpMesh
DistributedVector CreateDistributedVector(Vec vec, bool readOnly=false)
void SetupLinearSystem(Vec currentSolution, bool computeMatrix)
ExtendedBidomainAssembler< ELEM_DIM, SPACE_DIM > * mpExtendedBidomainAssembler
ExtendedBidomainSolver(bool bathSimulation, AbstractTetrahedralMesh< ELEM_DIM, SPACE_DIM > *pMesh, ExtendedBidomainTissue< SPACE_DIM > *pTissue, BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, 3 > *pBoundaryConditions)
ExtendedBidomainNeumannSurfaceTermAssembler< ELEM_DIM, SPACE_DIM > * mpExtendedBidomainNeumannSurfaceTermAssembler
void InitialiseForSolve(Vec initialSolution)
static double GetPdeTimeStep()
static void Finalise(Mat matrix)
static void Destroy(Vec &rVec)
static void SetupMat(Mat &rMat, int numRows, int numColumns, unsigned rowPreallocation, int numLocalRows=PETSC_DECIDE, int numLocalColumns=PETSC_DECIDE, bool ignoreOffProcEntries=true, bool newAllocationError=true)