Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
DifferentialAdhesionGeneralisedLinearSpringForce.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 "DifferentialAdhesionGeneralisedLinearSpringForce.hpp"
37#include "CellLabel.hpp"
38
39template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
41 : GeneralisedLinearSpringForce<ELEMENT_DIM, SPACE_DIM>(),
42 mHomotypicLabelledSpringConstantMultiplier(1.0),
43 mHeterotypicSpringConstantMultiplier(1.0)
44{
45}
46
47template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
49 unsigned nodeAGlobalIndex,
50 unsigned nodeBGlobalIndex,
52 bool isCloserThanRestLength)
53{
54
55 if (isCloserThanRestLength)
56 {
57 return 1.0;
58 }
59 else
60 {
61 // Determine which (if any) of the cells corresponding to these nodes are labelled
62 CellPtr p_cell_A = rCellPopulation.GetCellUsingLocationIndex(nodeAGlobalIndex);
63 bool cell_A_is_labelled = p_cell_A->template HasCellProperty<CellLabel>();
64
65 CellPtr p_cell_B = rCellPopulation.GetCellUsingLocationIndex(nodeBGlobalIndex);
66 bool cell_B_is_labelled = p_cell_B->template HasCellProperty<CellLabel>();
67
68 // For heterotypic interactions, scale the spring constant by mHeterotypicSpringConstantMultiplier
69 if (cell_A_is_labelled != cell_B_is_labelled)
70 {
71 return mHeterotypicSpringConstantMultiplier;
72 }
73 else
74 {
75 // For homotypic interactions between labelled cells, scale the spring constant by mHomotypicLabelledSpringConstantMultiplier
76 if (cell_A_is_labelled)
77 {
78 return mHomotypicLabelledSpringConstantMultiplier;
79 }
80 else
81 {
82 // For homotypic interactions between unlabelled cells, leave the spring constant unchanged from its normal value
83 return 1.0;
84 }
85 }
86 }
87}
88
89template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
94
95template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
97{
98 assert(labelledSpringConstantMultiplier > 0.0);
99 mHomotypicLabelledSpringConstantMultiplier = labelledSpringConstantMultiplier;
100}
101
102template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
107
108template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
110{
111 assert(heterotypicSpringConstantMultiplier > 0.0);
112 mHeterotypicSpringConstantMultiplier = heterotypicSpringConstantMultiplier;
113}
114
115template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
117{
118 *rParamsFile << "\t\t\t<HomotypicLabelledSpringConstantMultiplier>" << mHomotypicLabelledSpringConstantMultiplier << "</HomotypicLabelledSpringConstantMultiplier>\n";
119 *rParamsFile << "\t\t\t<HeterotypicSpringConstantMultiplier>" << mHeterotypicSpringConstantMultiplier << "</HeterotypicSpringConstantMultiplier>\n";
120
121 // Call direct parent class
123}
124
125// Explicit instantiation
132
133// Serialization for Boost >= 1.36
#define EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS)
virtual CellPtr GetCellUsingLocationIndex(unsigned index)
double VariableSpringConstantMultiplicationFactor(unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation, bool isCloserThanRestLength)
void SetHeterotypicSpringConstantMultiplier(double heterotypicSpringConstantMultiplier)
void SetHomotypicLabelledSpringConstantMultiplier(double labelledSpringConstantMultiplier)
virtual void OutputForceParameters(out_stream &rParamsFile)