Chaste  Release::3.4
VolumeConstraintPottsUpdateRule.hpp
1 /*
2 
3 Copyright (c) 2005-2016, 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 VOLUMECONSTRAINTUPDATERULE_HPP_
37 #define VOLUMECONSTRAINTUPDATERULE_HPP_
38 
39 #include "ChasteSerialization.hpp"
40 #include <boost/serialization/base_object.hpp>
41 
42 #include "AbstractPottsUpdateRule.hpp"
43 #include "PottsBasedCellPopulation.hpp"
44 
51 template<unsigned DIM>
53 {
54 friend class TestPottsUpdateRules;
55 
56 private:
57 
64 
71 
72  friend class boost::serialization::access;
80  template<class Archive>
81  void serialize(Archive & archive, const unsigned int version)
82  {
83  archive & boost::serialization::base_object<AbstractPottsUpdateRule<DIM> >(*this);
85  archive & mMatureCellTargetVolume;
86  }
87 
88 public:
89 
94 
99 
112  double EvaluateHamiltonianContribution(unsigned currentNodeIndex,
113  unsigned targetNodeIndex,
114  PottsBasedCellPopulation<DIM>& rCellPopulation);
115 
120 
126  void SetDeformationEnergyParameter(double deformationEnergyParameter);
127 
131  double GetMatureCellTargetVolume() const;
132 
138  void SetMatureCellTargetVolume(double matureCellTargetVolume);
139 
145  void OutputUpdateRuleParameters(out_stream& rParamsFile);
146 };
147 
150 
151 #endif /*VOLUMECONSTRAINTUPDATERULE_HPP_*/
void SetMatureCellTargetVolume(double matureCellTargetVolume)
void serialize(Archive &archive, const unsigned int version)
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
void SetDeformationEnergyParameter(double deformationEnergyParameter)
void OutputUpdateRuleParameters(out_stream &rParamsFile)
double EvaluateHamiltonianContribution(unsigned currentNodeIndex, unsigned targetNodeIndex, PottsBasedCellPopulation< DIM > &rCellPopulation)