Chaste  Release::3.4
CryptProjectionForce.hpp
1 /*
2 
3 Copyright (c) 2005-2016, 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 CRYPTPROJECTIONFORCE_HPP_
37 #define CRYPTPROJECTIONFORCE_HPP_
38 
39 #include "GeneralisedLinearSpringForce.hpp"
40 
41 #include "ChasteSerialization.hpp"
42 #include <boost/serialization/base_object.hpp>
43 
48 {
49  friend class TestCryptProjectionForce;
50 
51 private:
52 
53  friend class boost::serialization::access;
61  template<class Archive>
62  void serialize(Archive & archive, const unsigned int version)
63  {
64  archive & boost::serialization::base_object<GeneralisedLinearSpringForce<2> >(*this);
65  archive & mA;
66  archive & mB;
67  archive & mIncludeWntChemotaxis;
68  archive & mWntChemotaxisStrength;
69  }
70 
75  double mA;
76 
81  double mB;
82 
87 
92 
96  std::map<unsigned, c_vector<double, 3> > mNode3dLocationMap;
97 
103  void UpdateNode3dLocationMap(AbstractCellPopulation<2>& rCellPopulation);
104 
116  c_vector<double,2> CalculateForceBetweenNodes(unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation<2>& rCellPopulation);
117 
118 public:
119 
124 
129 
133  double GetA() const;
134 
138  double GetB() const;
139 
143  double GetWntChemotaxisStrength();
144 
150  void SetWntChemotaxisStrength(double wntChemotaxisStrength);
151 
157  void SetWntChemotaxis(bool includeWntChemotaxis);
158 
168  double CalculateCryptSurfaceHeightAtPoint(const c_vector<double,2>& rNodeLocation);
169 
178  double CalculateCryptSurfaceDerivativeAtPoint(const c_vector<double,2>& rNodeLocation);
179 
185  void AddForceContribution(AbstractCellPopulation<2>& rCellPopulation);
186 
192  void OutputForceParameters(out_stream& rParamsFile);
193 };
194 
195 // Declare identifier for the serializer
198 
199 #endif /*CRYPTPROJECTIONFORCE_HPP_*/
void SetWntChemotaxis(bool includeWntChemotaxis)
double CalculateCryptSurfaceDerivativeAtPoint(const c_vector< double, 2 > &rNodeLocation)
double CalculateCryptSurfaceHeightAtPoint(const c_vector< double, 2 > &rNodeLocation)
void UpdateNode3dLocationMap(AbstractCellPopulation< 2 > &rCellPopulation)
c_vector< double, 2 > CalculateForceBetweenNodes(unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< 2 > &rCellPopulation)
void serialize(Archive &archive, const unsigned int version)
std::map< unsigned, c_vector< double, 3 > > mNode3dLocationMap
void OutputForceParameters(out_stream &rParamsFile)
void AddForceContribution(AbstractCellPopulation< 2 > &rCellPopulation)
void SetWntChemotaxisStrength(double wntChemotaxisStrength)
#define CHASTE_CLASS_EXPORT(T)