Chaste  Release::2018.1
NagaiHondaForce.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 NAGAIHONDAFORCE_HPP_
37 #define NAGAIHONDAFORCE_HPP_
38 
39 #include "ChasteSerialization.hpp"
40 #include <boost/serialization/base_object.hpp>
41 #include "Exception.hpp"
42 
43 #include "AbstractForce.hpp"
44 #include "VertexBasedCellPopulation.hpp"
45 
46 #include <iostream>
47 
60 template<unsigned DIM>
61 class NagaiHondaForce : public AbstractForce<DIM>
62 {
63 friend class TestForces;
64 
65 private:
66 
67  friend class boost::serialization::access;
75  template<class Archive>
76  void serialize(Archive & archive, const unsigned int version)
77  {
78  archive & boost::serialization::base_object<AbstractForce<DIM> >(*this);
83  }
84 
85 protected:
86 
91 
96 
104 
109 
110 
111 public:
112 
116  NagaiHondaForce();
117 
121  virtual ~NagaiHondaForce();
122 
131  virtual void AddForceContribution(AbstractCellPopulation<DIM>& rCellPopulation);
132 
142  virtual double GetAdhesionParameter(Node<DIM>* pNodeA, Node<DIM>* pNodeB, VertexBasedCellPopulation<DIM>& rVertexCellPopulation);
143 
148 
153 
158 
163 
169  void SetNagaiHondaDeformationEnergyParameter(double nagaiHondaDeformationEnergyParameter);
170 
176  void SetNagaiHondaMembraneSurfaceEnergyParameter(double nagaiHondaMembraneSurfaceEnergyParameter);
177 
184  void SetNagaiHondaCellCellAdhesionEnergyParameter(double nagaiHondaCellCellAdhesionEnergyEnergyParameter);
185 
191  void SetNagaiHondaCellBoundaryAdhesionEnergyParameter(double nagaiHondaCellBoundaryAdhesionEnergyParameter);
192 
198  void OutputForceParameters(out_stream& rParamsFile);
199 };
200 
203 
204 #endif /*NAGAIHONDAFORCE_HPP_*/
Definition: Node.hpp:58
double mNagaiHondaMembraneSurfaceEnergyParameter
double GetNagaiHondaMembraneSurfaceEnergyParameter()
void SetNagaiHondaMembraneSurfaceEnergyParameter(double nagaiHondaMembraneSurfaceEnergyParameter)
void SetNagaiHondaCellBoundaryAdhesionEnergyParameter(double nagaiHondaCellBoundaryAdhesionEnergyParameter)
void OutputForceParameters(out_stream &rParamsFile)
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
void serialize(Archive &archive, const unsigned int version)
double mNagaiHondaCellCellAdhesionEnergyParameter
double mNagaiHondaCellBoundaryAdhesionEnergyParameter
void SetNagaiHondaDeformationEnergyParameter(double nagaiHondaDeformationEnergyParameter)
virtual ~NagaiHondaForce()
void SetNagaiHondaCellCellAdhesionEnergyParameter(double nagaiHondaCellCellAdhesionEnergyEnergyParameter)
double GetNagaiHondaCellCellAdhesionEnergyParameter()
double GetNagaiHondaCellBoundaryAdhesionEnergyParameter()
double GetNagaiHondaDeformationEnergyParameter()
double mNagaiHondaDeformationEnergyParameter
virtual double GetAdhesionParameter(Node< DIM > *pNodeA, Node< DIM > *pNodeB, VertexBasedCellPopulation< DIM > &rVertexCellPopulation)
gcov doesn't like this file...
virtual void AddForceContribution(AbstractCellPopulation< DIM > &rCellPopulation)