Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AdhesionPottsUpdateRule.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 ADHESIONUPDATERULE_HPP_
37#define ADHESIONUPDATERULE_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include "AbstractPottsUpdateRule.hpp"
43#include "PottsBasedCellPopulation.hpp"
44
49template<unsigned DIM>
51{
52friend class TestPottsUpdateRules;
53
54private:
55
62
69
70 friend class boost::serialization::access;
78 template<class Archive>
79 void serialize(Archive & archive, const unsigned int version)
80 {
81 archive & boost::serialization::base_object<AbstractPottsUpdateRule<DIM> >(*this);
84 }
85
86public:
87
92
97
110 double EvaluateHamiltonianContribution(unsigned currentNodeIndex,
111 unsigned targetNodeIndex,
112 PottsBasedCellPopulation<DIM>& rCellPopulation);
113
123 virtual double GetCellCellAdhesionEnergy(CellPtr pCellA, CellPtr pCellB);
124
133 virtual double GetCellBoundaryAdhesionEnergy(CellPtr pCell);
134
139
144
150 void SetCellCellAdhesionEnergyParameter(double cellCellAdhesionEnergyEnergyParameter);
151
157 void SetCellBoundaryAdhesionEnergyParameter(double cellBoundaryAdhesionEnergyParameter);
158
164 void OutputUpdateRuleParameters(out_stream& rParamsFile);
165};
166
169
170#endif /*ADHESIONUPDATERULE_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
void SetCellCellAdhesionEnergyParameter(double cellCellAdhesionEnergyEnergyParameter)
double EvaluateHamiltonianContribution(unsigned currentNodeIndex, unsigned targetNodeIndex, PottsBasedCellPopulation< DIM > &rCellPopulation)
virtual double GetCellCellAdhesionEnergy(CellPtr pCellA, CellPtr pCellB)
void OutputUpdateRuleParameters(out_stream &rParamsFile)
void serialize(Archive &archive, const unsigned int version)
virtual double GetCellBoundaryAdhesionEnergy(CellPtr pCell)
void SetCellBoundaryAdhesionEnergyParameter(double cellBoundaryAdhesionEnergyParameter)