Chaste
Commit::baa90ac2819b962188b7562f2326be23c47859a7
OdeLinearSystemSolver.cpp
1
/*
2
3
Copyright (c) 2005-2024, University of Oxford.
4
All rights reserved.
5
6
University of Oxford means the Chancellor, Masters and Scholars of the
7
University of Oxford, having an administrative office at Wellington
8
Square, Oxford OX1 2JD, UK.
9
10
This file is part of Chaste.
11
12
Redistribution and use in source and binary forms, with or without
13
modification, 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
23
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34
*/
35
36
#include "OdeLinearSystemSolver.hpp"
37
38
OdeLinearSystemSolver::OdeLinearSystemSolver
(
unsigned
systemSize,
double
timeStep)
39
: mLinearSystem(systemSize)
40
{
41
assert(timeStep > 0.0);
42
mTimeStep
= timeStep;
43
44
// Initialise vectors to zero
45
mCurrentSolution
=
PetscTools::CreateAndSetVec
(systemSize, 0.0);
46
mForceVector
=
PetscTools::CreateAndSetVec
(systemSize, 0.0);
47
}
48
49
OdeLinearSystemSolver::~OdeLinearSystemSolver
()
50
{
51
PetscTools::Destroy
(
mCurrentSolution
);
52
PetscTools::Destroy
(
mForceVector
);
53
}
54
55
double
OdeLinearSystemSolver::GetTimeStep
()
56
{
57
return
mTimeStep
;
58
}
59
60
Mat
&
OdeLinearSystemSolver::rGetLhsMatrix
()
61
{
62
return
mLinearSystem
.
rGetLhsMatrix
();
63
}
64
65
Vec
&
OdeLinearSystemSolver::rGetForceVector
()
66
{
67
return
mForceVector
;
68
}
69
70
void
OdeLinearSystemSolver::SetInitialConditionVector
(
Vec
initialConditionsVector)
71
{
72
VecCopy(initialConditionsVector,
mCurrentSolution
);
73
}
74
75
Vec
OdeLinearSystemSolver::SolveOneTimeStep
()
76
{
77
// Compute the product of the LHS matrix and the current solution vector,
78
// setting the answer to be the RHS vector
79
MatMult(
mLinearSystem
.
rGetLhsMatrix
(),
mCurrentSolution
,
mLinearSystem
.
rGetRhsVector
());
80
81
// Add timestep multipled by force vector
82
PetscVecTools::AddScaledVector
(
mLinearSystem
.
rGetRhsVector
(),
mForceVector
,
mTimeStep
);
83
84
// avoid memory leaks
85
PetscTools::Destroy
(
mCurrentSolution
);
86
87
// Having constructed the RHS vector, solve the resulting linear system...
88
mCurrentSolution
=
mLinearSystem
.
Solve
();
89
90
return
mCurrentSolution
;
91
}
LinearSystem::Solve
Vec Solve(Vec lhsGuess=nullptr)
Definition
LinearSystem.cpp:674
LinearSystem::rGetLhsMatrix
Mat & rGetLhsMatrix()
Definition
LinearSystem.cpp:519
LinearSystem::rGetRhsVector
Vec & rGetRhsVector()
Definition
LinearSystem.cpp:509
Mat
OdeLinearSystemSolver::SolveOneTimeStep
Vec SolveOneTimeStep()
Definition
OdeLinearSystemSolver.cpp:75
OdeLinearSystemSolver::mLinearSystem
LinearSystem mLinearSystem
Definition
OdeLinearSystemSolver.hpp:64
OdeLinearSystemSolver::mForceVector
Vec mForceVector
Definition
OdeLinearSystemSolver.hpp:67
OdeLinearSystemSolver::rGetForceVector
Vec & rGetForceVector()
Definition
OdeLinearSystemSolver.cpp:65
OdeLinearSystemSolver::GetTimeStep
double GetTimeStep()
Definition
OdeLinearSystemSolver.cpp:55
OdeLinearSystemSolver::SetInitialConditionVector
void SetInitialConditionVector(Vec initialConditionsVector)
Definition
OdeLinearSystemSolver.cpp:70
OdeLinearSystemSolver::~OdeLinearSystemSolver
~OdeLinearSystemSolver()
Definition
OdeLinearSystemSolver.cpp:49
OdeLinearSystemSolver::mTimeStep
double mTimeStep
Definition
OdeLinearSystemSolver.hpp:61
OdeLinearSystemSolver::rGetLhsMatrix
Mat & rGetLhsMatrix()
Definition
OdeLinearSystemSolver.cpp:60
OdeLinearSystemSolver::OdeLinearSystemSolver
OdeLinearSystemSolver(unsigned systemSize, double timeStep)
Definition
OdeLinearSystemSolver.cpp:38
OdeLinearSystemSolver::mCurrentSolution
Vec mCurrentSolution
Definition
OdeLinearSystemSolver.hpp:70
PetscTools::CreateAndSetVec
static Vec CreateAndSetVec(int size, double value)
Definition
PetscTools.cpp:258
PetscTools::Destroy
static void Destroy(Vec &rVec)
Definition
PetscTools.hpp:366
PetscVecTools::AddScaledVector
static void AddScaledVector(Vec y, Vec x, double scaleFactor)
Definition
PetscVecTools.cpp:127
Vec
cell_based
src
common
OdeLinearSystemSolver.cpp
Generated by
1.9.8