Chaste  Release::2018.1
AbstractNumericalMethod.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 ABSTRACTNUMERICALMETHOD_HPP_
37 #define ABSTRACTNUMERICALMETHOD_HPP_
38 
39 #include <boost/shared_ptr.hpp>
40 #include "ChasteSerialization.hpp"
41 #include "ClassIsAbstract.hpp"
42 #include "Identifiable.hpp"
43 
44 #include "AbstractOffLatticeCellPopulation.hpp"
45 #include "AbstractForce.hpp"
46 
54 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM=ELEMENT_DIM>
56 {
57  friend class TestNumericalMethods;
58 
59 private:
60 
63 
70  template<class Archive>
71  void serialize(Archive & archive, const unsigned int version)
72  {
73  archive & mUseAdaptiveTimestep;
74  archive & mUseUpdateNodeLocation;
75  archive & mGhostNodeForcesEnabled;
76  }
77 
78 protected:
79 
82 
84  std::vector<boost::shared_ptr<AbstractForce<ELEMENT_DIM, SPACE_DIM> > >* mpForceCollection;
85 
91 
102 
108 
113  std::vector<c_vector<double, SPACE_DIM> > ComputeForcesIncludingDamping();
114 
119  std::vector<c_vector<double, SPACE_DIM> > SaveCurrentLocations();
120 
127  void SafeNodePositionUpdate(unsigned nodeIndex, c_vector<double, SPACE_DIM> newPosition);
128 
138  void DetectStepSizeExceptions(unsigned nodeIndex, c_vector<double,SPACE_DIM>& displacement, double dt);
139 
140 public:
141 
149 
154 
161 
167  void SetForceCollection(std::vector<boost::shared_ptr<AbstractForce<ELEMENT_DIM, SPACE_DIM> > >* pForces);
168 
174  void SetUseAdaptiveTimestep(bool useAdaptiveTimestep);
175 
181  void SetUseUpdateNodeLocation(bool useUpdateNodeLocation);
182 
189 
193  bool HasAdaptiveTimestep();
194 
203  virtual void UpdateAllNodePositions(double dt)=0;
204 
210  void OutputNumericalMethodInfo(out_stream& rParamsFile);
211 
217  virtual void OutputNumericalMethodParameters(out_stream& rParamsFile);
218 };
219 
221 
222 #endif /*ABSTRACTNUMERICALMETHOD_HPP_*/
#define TEMPLATED_CLASS_IS_ABSTRACT_2_UNSIGNED(T)
void SafeNodePositionUpdate(unsigned nodeIndex, c_vector< double, SPACE_DIM > newPosition)
friend class boost::serialization::access
void SetForceCollection(std::vector< boost::shared_ptr< AbstractForce< ELEMENT_DIM, SPACE_DIM > > > *pForces)
std::vector< boost::shared_ptr< AbstractForce< ELEMENT_DIM, SPACE_DIM > > > * mpForceCollection
AbstractOffLatticeCellPopulation< ELEMENT_DIM, SPACE_DIM > * mpCellPopulation
virtual void OutputNumericalMethodParameters(out_stream &rParamsFile)
void OutputNumericalMethodInfo(out_stream &rParamsFile)
virtual void UpdateAllNodePositions(double dt)=0
void SetUseUpdateNodeLocation(bool useUpdateNodeLocation)
void SetUseAdaptiveTimestep(bool useAdaptiveTimestep)
void serialize(Archive &archive, const unsigned int version)
void SetCellPopulation(AbstractOffLatticeCellPopulation< ELEMENT_DIM, SPACE_DIM > *pPopulation)
std::vector< c_vector< double, SPACE_DIM > > SaveCurrentLocations()
void DetectStepSizeExceptions(unsigned nodeIndex, c_vector< double, SPACE_DIM > &displacement, double dt)
std::vector< c_vector< double, SPACE_DIM > > ComputeForcesIncludingDamping()