Chaste  Release::2018.1
AbstractOdeBasedContractionModel.hpp
1 /*
2 
3 Copyright (c) 2005-2018, 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 #ifndef ABSTRACTODEBASEDCONTRACTIONMODEL_
37 #define ABSTRACTODEBASEDCONTRACTIONMODEL_
38 
39 #include "AbstractOdeSystem.hpp"
40 #include "AbstractContractionModel.hpp"
41 #include "AbstractIvpOdeSolver.hpp"
42 #include "EulerIvpOdeSolver.hpp"
43 
59 {
60 protected:
61 
64  std::vector<double> mTemporaryStateVariables;
65 
67  double mTime;
68 
69 public:
74  AbstractOdeBasedContractionModel(unsigned numStateVariables)
75  : AbstractOdeSystem(numStateVariables),
77  mTime(0.0)
78  {
79  // note mTemporaryStateVariables not resized here - only resized if needed
80  }
81 
82 
93  virtual void RunDoNotUpdate(double startTime, double endTime, double timeStep)
94  {
95  // save the state variables
96  if (mTemporaryStateVariables.size() > 0)
97  {
99  }
101 
102  // solve (RunAndUpdate just calls SolveAndUpdateStateVariable() using an euler solver)
103  RunAndUpdate(startTime, endTime, timeStep);
104 
105  // put the solution in mTemporaryStateVariables and return the state variables to its
106  // original state
107  for (unsigned i=0; i<mStateVariables.size(); i++)
108  {
109  double soln = mStateVariables[i];
111  mTemporaryStateVariables[i] = soln;
112  }
113 
114  // note that the end time was saved in RunAndUpdate(): mTime = endTime;
115  }
116 
122  {
123  // save the state variables
124  for (unsigned i=0; i<mStateVariables.size(); i++)
125  {
127  }
128  }
129 
142  void RunAndUpdate(double startTime, double endTime, double timeStep)
143  {
144  EulerIvpOdeSolver solver;
145  solver.SolveAndUpdateStateVariable(this, startTime, endTime, timeStep);
146 
147  mTime = endTime;
148  }
149 };
150 
151 
152 #endif /*ABSTRACTODEBASEDSTRETCHINDEPENDENTCONTRACTIONMODEL_*/
virtual void RunDoNotUpdate(double startTime, double endTime, double timeStep)
void RunAndUpdate(double startTime, double endTime, double timeStep)
virtual void SolveAndUpdateStateVariable(AbstractOdeSystem *pAbstractOdeSystem, double startTime, double endTime, double timeStep)
AbstractOdeBasedContractionModel(unsigned numStateVariables)