Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
FarhadifarForce.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF 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
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
54template<unsigned DIM>
55class FarhadifarForce : public AbstractForce<DIM>
56{
57friend class TestForces;
58
59private:
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);
75 archive & mLineTensionParameter;
77 archive & mTargetAreaParameter;
78 }
79
80protected:
81
86
91
96
101
110
111public:
112
117
121 virtual ~FarhadifarForce();
122
131 virtual void AddForceContribution(AbstractCellPopulation<DIM>& rCellPopulation);
132
142 virtual double GetLineTensionParameter(Node<DIM>* pNodeA, Node<DIM>* pNodeB, VertexBasedCellPopulation<DIM>& rVertexCellPopulation);
143
148
153
158
163
167 double GetTargetAreaParameter();
168
174 void SetAreaElasticityParameter(double areaElasticityParameter);
175
181 void SetPerimeterContractilityParameter(double perimeterContractilityParameter);
182
188 void SetLineTensionParameter(double lineTensionParameter);
189
195 void SetBoundaryLineTensionParameter(double boundaryLineTensionParameter);
196
202 void SetTargetAreaParameter(double targetAreaParameter);
203
209 void OutputForceParameters(out_stream& rParamsFile);
210};
211
214
215#endif /*FARHADIFARFORCE_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
void SetAreaElasticityParameter(double areaElasticityParameter)
double mPerimeterContractilityParameter
void SetBoundaryLineTensionParameter(double boundaryLineTensionParameter)
void serialize(Archive &archive, const unsigned int version)
virtual void AddForceContribution(AbstractCellPopulation< DIM > &rCellPopulation)
void SetPerimeterContractilityParameter(double perimeterContractilityParameter)
double GetTargetAreaParameter()
double mBoundaryLineTensionParameter
virtual ~FarhadifarForce()
double GetBoundaryLineTensionParameter()
double mAreaElasticityParameter
double GetPerimeterContractilityParameter()
void OutputForceParameters(out_stream &rParamsFile)
double GetAreaElasticityParameter()
double GetLineTensionParameter()
void SetTargetAreaParameter(double targetAreaParameter)
void SetLineTensionParameter(double lineTensionParameter)
Definition Node.hpp:59