Chaste  Release::2018.1
GeneralisedLinearSpringForce.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 GENERALISEDLINEARSPRINGFORCE_HPP_
37 #define GENERALISEDLINEARSPRINGFORCE_HPP_
38 
39 #include "AbstractTwoBodyInteractionForce.hpp"
40 
41 #include "ChasteSerialization.hpp"
42 #include <boost/serialization/base_object.hpp>
43 
64 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM=ELEMENT_DIM>
65 class GeneralisedLinearSpringForce : public AbstractTwoBodyInteractionForce<ELEMENT_DIM, SPACE_DIM>
66 {
67  friend class TestForces;
68 
69 private:
70 
72  friend class boost::serialization::access;
79  template<class Archive>
80  void serialize(Archive & archive, const unsigned int version)
81  {
82  archive & boost::serialization::base_object<AbstractTwoBodyInteractionForce<ELEMENT_DIM, SPACE_DIM> >(*this);
83  archive & mMeinekeSpringStiffness;
86  }
87 
88 protected:
89 
98 
107 
115 
116 public:
117 
122 
127 
141  virtual double VariableSpringConstantMultiplicationFactor(unsigned nodeAGlobalIndex,
142  unsigned nodeBGlobalIndex,
144  bool isCloserThanRestLength);
145 
158  c_vector<double, SPACE_DIM> CalculateForceBetweenNodes(unsigned nodeAGlobalIndex,
159  unsigned nodeBGlobalIndex,
164  double GetMeinekeSpringStiffness();
165 
170 
175 
181  void SetMeinekeSpringStiffness(double springStiffness);
182 
188  void SetMeinekeDivisionRestingSpringLength(double divisionRestingSpringLength);
189 
195  void SetMeinekeSpringGrowthDuration(double springGrowthDuration);
196 
202  virtual void OutputForceParameters(out_stream& rParamsFile);
203 };
204 
207 
208 #endif /*GENERALISEDLINEARSPRINGFORCE_HPP_*/
c_vector< double, SPACE_DIM > CalculateForceBetweenNodes(unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
void serialize(Archive &archive, const unsigned int version)
#define EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS)
void SetMeinekeDivisionRestingSpringLength(double divisionRestingSpringLength)
void SetMeinekeSpringGrowthDuration(double springGrowthDuration)
virtual double VariableSpringConstantMultiplicationFactor(unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation, bool isCloserThanRestLength)
virtual void OutputForceParameters(out_stream &rParamsFile)
void SetMeinekeSpringStiffness(double springStiffness)
gcov doesn't like this file...