Chaste  Release::2018.1
FarhadifarForce.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 FARHADIFARFORCE_HPP_
37 #define FARHADIFARFORCE_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 
54 template<unsigned DIM>
55 class FarhadifarForce : public AbstractForce<DIM>
56 {
57 friend class TestForces;
58 
59 private:
60 
61  friend class boost::serialization::access;
69  template<class Archive>
70  void serialize(Archive & archive, const unsigned int version)
71  {
72  archive & boost::serialization::base_object<AbstractForce<DIM> >(*this);
73  archive & mAreaElasticityParameter;
75  archive & mLineTensionParameter;
77  }
78 
79 protected:
80 
85 
90 
95 
100 
101 
102 public:
103 
107  FarhadifarForce();
108 
112  virtual ~FarhadifarForce();
113 
122  virtual void AddForceContribution(AbstractCellPopulation<DIM>& rCellPopulation);
123 
133  virtual double GetLineTensionParameter(Node<DIM>* pNodeA, Node<DIM>* pNodeB, VertexBasedCellPopulation<DIM>& rVertexCellPopulation);
134 
139 
144 
148  double GetLineTensionParameter();
149 
154 
160  void SetAreaElasticityParameter(double areaElasticityParameter);
161 
167  void SetPerimeterContractilityParameter(double perimeterContractilityParameter);
168 
174  void SetLineTensionParameter(double lineTensionParameter);
175 
181  void SetBoundaryLineTensionParameter(double boundaryLineTensionParameter);
182 
188  void OutputForceParameters(out_stream& rParamsFile);
189 };
190 
193 
194 #endif /*FARHADIFARFORCE_HPP_*/
void SetAreaElasticityParameter(double areaElasticityParameter)
void OutputForceParameters(out_stream &rParamsFile)
Definition: Node.hpp:58
double GetLineTensionParameter()
void serialize(Archive &archive, const unsigned int version)
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
double mPerimeterContractilityParameter
virtual void AddForceContribution(AbstractCellPopulation< DIM > &rCellPopulation)
void SetPerimeterContractilityParameter(double perimeterContractilityParameter)
double mAreaElasticityParameter
double mLineTensionParameter
double GetAreaElasticityParameter()
double mBoundaryLineTensionParameter
double GetPerimeterContractilityParameter()
void SetLineTensionParameter(double lineTensionParameter)
double GetBoundaryLineTensionParameter()
gcov doesn't like this file...
virtual ~FarhadifarForce()
void SetBoundaryLineTensionParameter(double boundaryLineTensionParameter)