Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
NagaiHondaForce.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 NAGAIHONDAFORCE_HPP_
37#define NAGAIHONDAFORCE_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
60template<unsigned DIM>
61class NagaiHondaForce : public AbstractForce<DIM>
62{
63friend class TestForces;
64
65private:
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);
84 }
85
86protected:
87
92
97
105
110
119
120public:
121
126
130 virtual ~NagaiHondaForce();
131
140 virtual void AddForceContribution(AbstractCellPopulation<DIM>& rCellPopulation);
141
151 virtual double GetAdhesionParameter(Node<DIM>* pNodeA, Node<DIM>* pNodeB, VertexBasedCellPopulation<DIM>& rVertexCellPopulation);
152
157
162
167
172
177
183 void SetNagaiHondaDeformationEnergyParameter(double nagaiHondaDeformationEnergyParameter);
184
190 void SetNagaiHondaMembraneSurfaceEnergyParameter(double nagaiHondaMembraneSurfaceEnergyParameter);
191
198 void SetNagaiHondaCellCellAdhesionEnergyParameter(double nagaiHondaCellCellAdhesionEnergyEnergyParameter);
199
205 void SetNagaiHondaCellBoundaryAdhesionEnergyParameter(double nagaiHondaCellBoundaryAdhesionEnergyParameter);
206
212 void SetNagaiHondaTargetAreaParameter(double nagaiHondaTargetAreaParameter);
213
219 void OutputForceParameters(out_stream& rParamsFile);
220};
221
224
225#endif /*NAGAIHONDAFORCE_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
double GetNagaiHondaMembraneSurfaceEnergyParameter()
double GetNagaiHondaDeformationEnergyParameter()
double mNagaiHondaMembraneSurfaceEnergyParameter
double mNagaiHondaDeformationEnergyParameter
virtual void AddForceContribution(AbstractCellPopulation< DIM > &rCellPopulation)
void SetNagaiHondaMembraneSurfaceEnergyParameter(double nagaiHondaMembraneSurfaceEnergyParameter)
void SetNagaiHondaTargetAreaParameter(double nagaiHondaTargetAreaParameter)
double mNagaiHondaCellCellAdhesionEnergyParameter
void SetNagaiHondaCellBoundaryAdhesionEnergyParameter(double nagaiHondaCellBoundaryAdhesionEnergyParameter)
virtual ~NagaiHondaForce()
virtual double GetAdhesionParameter(Node< DIM > *pNodeA, Node< DIM > *pNodeB, VertexBasedCellPopulation< DIM > &rVertexCellPopulation)
void SetNagaiHondaDeformationEnergyParameter(double nagaiHondaDeformationEnergyParameter)
double mNagaiHondaTargetAreaParameter
double GetNagaiHondaCellBoundaryAdhesionEnergyParameter()
void serialize(Archive &archive, const unsigned int version)
double mNagaiHondaCellBoundaryAdhesionEnergyParameter
void SetNagaiHondaCellCellAdhesionEnergyParameter(double nagaiHondaCellCellAdhesionEnergyEnergyParameter)
void OutputForceParameters(out_stream &rParamsFile)
double GetNagaiHondaTargetAreaParameter()
double GetNagaiHondaCellCellAdhesionEnergyParameter()
Definition Node.hpp:59