CryptProjectionForce.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 CRYPTPROJECTIONFORCE_HPP_
00029 #define CRYPTPROJECTIONFORCE_HPP_
00030 
00031 #include "GeneralisedLinearSpringForce.hpp"
00032 
00033 #include "ChasteSerialization.hpp"
00034 #include <boost/serialization/base_object.hpp>
00035 
00039 class CryptProjectionForce : public GeneralisedLinearSpringForce<2>
00040 {
00041     friend class TestCryptProjectionForce;
00042 
00043 private:
00044 
00045     friend class boost::serialization::access;
00046     template<class Archive>
00047     void serialize(Archive & archive, const unsigned int version)
00048     {
00049         // If Archive is an output archive, then '&' resolves to '<<'
00050         // If Archive is an input archive, then '&' resolves to '>>'
00051         archive & boost::serialization::base_object<GeneralisedLinearSpringForce<2> >(*this);
00052         archive & mA;
00053         archive & mB;
00054         archive & mIncludeWntChemotaxis;
00055         archive & mWntChemotaxisStrength;
00056     }
00057 
00062     double mA;
00063 
00068     double mB;
00069 
00073     bool mIncludeWntChemotaxis;
00074 
00078     double mWntChemotaxisStrength;
00079 
00083     std::map<unsigned, c_vector<double, 3> > mNode3dLocationMap;
00084 
00090     void UpdateNode3dLocationMap(AbstractCellPopulation<2>& rCellPopulation);
00091 
00103     c_vector<double,2> CalculateForceBetweenNodes(unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation<2>& rCellPopulation);
00104 
00105 public:
00106 
00110     CryptProjectionForce();
00111 
00115     ~CryptProjectionForce();
00116 
00120     double GetA() const;
00121 
00125     double GetB() const;
00126 
00130     double GetWntChemotaxisStrength();
00131 
00137     void SetWntChemotaxisStrength(double wntChemotaxisStrength);
00138 
00144     void SetWntChemotaxis(bool includeWntChemotaxis);
00145 
00155     double CalculateCryptSurfaceHeightAtPoint(const c_vector<double,2>& rNodeLocation);
00156 
00165     double CalculateCryptSurfaceDerivativeAtPoint(const c_vector<double,2>& rNodeLocation);
00166 
00173     void AddForceContribution(std::vector<c_vector<double,2> >& rForces,
00174                               AbstractCellPopulation<2>& rCellPopulation);
00175 
00184     void OutputForceParameters(out_stream& rParamsFile);
00185 };
00186 
00187 // Declare identifier for the serializer
00188 #include "SerializationExportWrapper.hpp"
00189 CHASTE_CLASS_EXPORT(CryptProjectionForce)
00190 
00191 #endif /*CRYPTPROJECTIONFORCE_HPP_*/

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