Chaste  Release::2018.1
ForwardEulerNumericalMethod.cpp
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 #include "ForwardEulerNumericalMethod.hpp"
37 
38 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
40  : AbstractNumericalMethod<ELEMENT_DIM,SPACE_DIM>()
41 {
42 }
43 
44 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
46 {
47 }
48 
49 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
51 {
52  if (!this->mUseUpdateNodeLocation)
53  {
54  // Apply forces to each cell, and save a vector of net forces F
55  std::vector<c_vector<double, SPACE_DIM> > forces = this->ComputeForcesIncludingDamping();
56 
57  unsigned index = 0;
58  for (typename AbstractMesh<ELEMENT_DIM, SPACE_DIM>::NodeIterator node_iter = this->mpCellPopulation->rGetMesh().GetNodeIteratorBegin();
59  node_iter != this->mpCellPopulation->rGetMesh().GetNodeIteratorEnd();
60  ++node_iter, ++index)
61  {
62  // Get the current node location and calculate the new location according to the forward Euler method
63  const c_vector<double, SPACE_DIM>& r_old_location = node_iter->rGetLocation();
64  c_vector<double, SPACE_DIM> displacement = dt * forces[index];
65 
66  // In the vertex-based case, the displacement may be scaled if the cell rearrangement threshold is exceeded
67  this->DetectStepSizeExceptions(node_iter->GetIndex(), displacement, dt);
68 
69  c_vector<double, SPACE_DIM> new_location = r_old_location + displacement;
70  this->SafeNodePositionUpdate(node_iter->GetIndex(), new_location);
71  }
72  }
73  else
74  {
75  /*
76  * If this type of cell population does not support the new numerical methods, delegate
77  * updating node positions to the population itself.
78  *
79  * This only applies to NodeBasedCellPopulationWithBuskeUpdates.
80  */
81  this->mpCellPopulation->UpdateNodeLocations(dt);
82  }
83 }
84 
85 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
87 {
88  // No new parameters to output, so just call method on direct parent class
90 }
91 
92 // Explicit instantiation
99 
100 // Serialization for Boost >= 1.36
virtual void OutputNumericalMethodParameters(out_stream &rParamsFile)
virtual void OutputNumericalMethodParameters(out_stream &rParamsFile)
#define EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS)