Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
LinearSpringWithVariableSpringConstantsForce.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 LINEARSPRINGWITHVARIABLESPRINGCONSTANTSFORCE_HPP
37#define LINEARSPRINGWITHVARIABLESPRINGCONSTANTSFORCE_HPP
38
40#include <boost/serialization/base_object.hpp>
41
42#include "GeneralisedLinearSpringForce.hpp"
43
47template<unsigned DIM>
49{
50 friend class TestLinearSpringWithVariableSpringConstantsForce;
51
52private:
53
62 template<class Archive>
63 void serialize(Archive & archive, const unsigned int version)
64 {
65 archive & boost::serialization::base_object<GeneralisedLinearSpringForce<DIM> >(*this);
67 archive & mUseMutantSprings;
70 archive & mUseBCatSprings;
71 archive & mUseApoptoticSprings;
72 archive & mBetaCatSpringScaler;
75 }
76
77protected:
78
81
84
87
90
93
96
99
102
105
106public:
107
112
117
123 void SetEdgeBasedSpringConstant(bool useEdgeBasedSpringConstant);
124
133 void SetMutantSprings(bool useMutantSprings, double mutantMutantMultiplier=2, double normalMutantMultiplier=1.5);
134
140 void SetBetaCateninSprings(bool useBCatSprings);
141
147 void SetApoptoticSprings(bool useApoptoticSprings);
148
162 double VariableSpringConstantMultiplicationFactor(unsigned nodeAGlobalIndex,
163 unsigned nodeBGlobalIndex,
164 AbstractCellPopulation<DIM>& rCellPopulation,
165 bool isCloserThanRestLength);
166
173
177 double GetBetaCatSpringScaler();
178
184 void SetBetaCatSpringScaler(double betaCatSpringScaler);
185
190
196 void SetApoptoticSpringTensionStiffness(double apoptoticSpringTensionStiffness);
197
202
208 void SetApoptoticSpringCompressionStiffness(double apoptoticSpringCompressionStiffness);
209
215 virtual void OutputForceParameters(out_stream& rParamsFile);
216};
217
220
221#endif /*LINEARSPRINGWITHVARIABLESPRINGCONSTANTSFORCE_HPP*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
void AddForceContribution(AbstractCellPopulation< DIM > &rCellPopulation)
void SetMutantSprings(bool useMutantSprings, double mutantMutantMultiplier=2, double normalMutantMultiplier=1.5)
void serialize(Archive &archive, const unsigned int version)
double VariableSpringConstantMultiplicationFactor(unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< DIM > &rCellPopulation, bool isCloserThanRestLength)
void SetApoptoticSpringCompressionStiffness(double apoptoticSpringCompressionStiffness)
void SetApoptoticSpringTensionStiffness(double apoptoticSpringTensionStiffness)