LinearSpringWithVariableSpringConstantsForce.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 #ifndef LINEARSPRINGWITHVARIABLESPRINGCONSTANTSFORCE_HPP
00029 #define LINEARSPRINGWITHVARIABLESPRINGCONSTANTSFORCE_HPP
00030 
00031 #include "GeneralisedLinearSpringForce.hpp"
00032 
00033 #include "ChasteSerialization.hpp"
00034 #include <boost/serialization/base_object.hpp>
00035 
00036 // Needed here to avoid serialization errors (on Boost<1.37)
00037 #include "ApcTwoHitCellMutationState.hpp"
00038 #include "BetaCateninOneHitCellMutationState.hpp"
00039 
00043 template<unsigned DIM>
00044 class LinearSpringWithVariableSpringConstantsForce : public GeneralisedLinearSpringForce<DIM>
00045 {
00046     friend class TestLinearSpringWithVariableSpringConstantsForce;
00047 
00048 private:
00049 
00051     friend class boost::serialization::access;
00058     template<class Archive>
00059     void serialize(Archive & archive, const unsigned int version)
00060     {
00061         // If Archive is an output archive, then '&' resolves to '<<'
00062         // If Archive is an input archive, then '&' resolves to '>>'
00063         archive & boost::serialization::base_object<GeneralisedLinearSpringForce<DIM> >(*this);
00064         archive & mUseEdgeBasedSpringConstant;
00065         archive & mUseMutantSprings;
00066         archive & mMutantMutantMultiplier;
00067         archive & mNormalMutantMultiplier;
00068         archive & mUseBCatSprings;
00069         archive & mUseApoptoticSprings;
00070         archive & mBetaCatSpringScaler;
00071         archive & mApoptoticSpringTensionStiffness;
00072         archive & mApoptoticSpringCompressionStiffness;
00073     }
00074 
00075 protected:
00076 
00078     bool mUseEdgeBasedSpringConstant;
00079 
00081     bool mUseMutantSprings;
00082 
00084     double mMutantMutantMultiplier;
00085 
00087     double mNormalMutantMultiplier;
00088 
00090     bool mUseBCatSprings;
00091 
00093     bool mUseApoptoticSprings;
00094 
00096     double mBetaCatSpringScaler;
00097 
00099     double mApoptoticSpringTensionStiffness;
00100 
00102     double mApoptoticSpringCompressionStiffness;
00103 
00104 public:
00105 
00109     LinearSpringWithVariableSpringConstantsForce();
00110 
00114     ~LinearSpringWithVariableSpringConstantsForce();
00115 
00121     void SetEdgeBasedSpringConstant(bool useEdgeBasedSpringConstant);
00122 
00131     void SetMutantSprings(bool useMutantSprings, double mutantMutantMultiplier=2, double normalMutantMultiplier=1.5);
00132 
00138     void SetBetaCateninSprings(bool useBCatSprings);
00139 
00145     void SetApoptoticSprings(bool useApoptoticSprings);
00146 
00160     double VariableSpringConstantMultiplicationFactor(unsigned nodeAGlobalIndex,
00161                                                       unsigned nodeBGlobalIndex,
00162                                                       AbstractCellPopulation<DIM>& rCellPopulation,
00163                                                       bool isCloserThanRestLength);
00164 
00171     void AddForceContribution(std::vector<c_vector<double, DIM> >& rForces,
00172                               AbstractCellPopulation<DIM>& rCellPopulation);
00173 
00177     double GetBetaCatSpringScaler();
00178 
00184     void SetBetaCatSpringScaler(double betaCatSpringScaler);
00185 
00189     double GetApoptoticSpringTensionStiffness();
00190 
00196     void SetApoptoticSpringTensionStiffness(double apoptoticSpringTensionStiffness);
00197 
00201     double GetApoptoticSpringCompressionStiffness();
00202 
00208     void SetApoptoticSpringCompressionStiffness(double apoptoticSpringCompressionStiffness);
00209 
00218     virtual void OutputForceParameters(out_stream& rParamsFile);
00219 };
00220 
00221 #include "SerializationExportWrapper.hpp"
00222 
00223 EXPORT_TEMPLATE_CLASS_SAME_DIMS(LinearSpringWithVariableSpringConstantsForce)
00224 
00225 
00226 #endif /*LINEARSPRINGWITHVARIABLESPRINGCONSTANTSFORCE_HPP*/

Generated on Tue May 31 14:31:41 2011 for Chaste by  doxygen 1.5.5