Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
VolumeConstraintPottsUpdateRule.cpp
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#include "VolumeConstraintPottsUpdateRule.hpp"
37
38template<unsigned DIM>
41 mDeformationEnergyParameter(0.5), // Educated guess
42 mMatureCellTargetVolume(16.0) // Defaults to a 4*4 cell size
43{
45}
46
47template<unsigned DIM>
51
52template<unsigned DIM>
54 unsigned targetNodeIndex,
55 PottsBasedCellPopulation<DIM>& rCellPopulation)
56{
57 double delta_H = 0.0;
58
59 std::set<unsigned> containing_elements = rCellPopulation.GetNode(currentNodeIndex)->rGetContainingElementIndices();
60 std::set<unsigned> new_location_containing_elements = rCellPopulation.GetNode(targetNodeIndex)->rGetContainingElementIndices();
61
62 bool current_node_contained = !containing_elements.empty();
63 bool target_node_contained = !new_location_containing_elements.empty();
64
65 // Every node must each be in at most one element
66 assert(new_location_containing_elements.size() < 2);
67
68 if (!current_node_contained && !target_node_contained)
69 {
70 EXCEPTION("At least one of the current node or target node must be in an element.");
71 }
72
73 if (current_node_contained && target_node_contained)
74 {
75 if (*(new_location_containing_elements.begin()) == *(containing_elements.begin()))
76 {
77 EXCEPTION("The current node and target node must not be in the same element.");
78 }
79 }
80
81 if (current_node_contained) // current node is in an element
82 {
83 unsigned current_element = (*containing_elements.begin());
84 double current_volume = rCellPopulation.rGetMesh().GetVolumeOfElement(current_element);
85 double current_volume_difference = current_volume - mMatureCellTargetVolume;
86
87 delta_H += mDeformationEnergyParameter*((current_volume_difference + 1.0)*(current_volume_difference + 1.0) - current_volume_difference*current_volume_difference);
88 }
89 if (target_node_contained) // target node is in an element
90 {
91 unsigned target_element = (*new_location_containing_elements.begin());
92 double target_volume = rCellPopulation.rGetMesh().GetVolumeOfElement(target_element);
93 double target_volume_difference = target_volume - mMatureCellTargetVolume;
94
95 delta_H += mDeformationEnergyParameter*((target_volume_difference - 1.0)*(target_volume_difference - 1.0) - target_volume_difference*target_volume_difference);
96 }
97
98 return delta_H;
99}
100
101template<unsigned DIM>
103{
104 return mDeformationEnergyParameter;
105}
106
107template<unsigned DIM>
109{
110 mDeformationEnergyParameter = deformationEnergyParameter;
111}
112
113template<unsigned DIM>
115{
116 return mMatureCellTargetVolume;
117}
118
119template<unsigned DIM>
121{
122 assert(matureCellTargetVolume >= 0.0);
123 mMatureCellTargetVolume = matureCellTargetVolume;
124}
125
126template<unsigned DIM>
128{
129 *rParamsFile << "\t\t\t<DeformationEnergyParameter>" << mDeformationEnergyParameter << "</DeformationEnergyParameter>\n";
130 *rParamsFile << "\t\t\t<MatureCellTargetVolume>" << mMatureCellTargetVolume << "</MatureCellTargetVolume>\n";
131
132 // Call method on direct parent class
134}
135
136// Explicit instantiation
140
141// Serialization for Boost >= 1.36
#define EXCEPTION(message)
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
virtual void OutputUpdateRuleParameters(out_stream &rParamsFile)
std::set< unsigned > & rGetContainingElementIndices()
Definition Node.cpp:300
Node< DIM > * GetNode(unsigned index)
void OutputUpdateRuleParameters(out_stream &rParamsFile)
void SetMatureCellTargetVolume(double matureCellTargetVolume)
double EvaluateHamiltonianContribution(unsigned currentNodeIndex, unsigned targetNodeIndex, PottsBasedCellPopulation< DIM > &rCellPopulation)
void SetDeformationEnergyParameter(double deformationEnergyParameter)