ChemotacticForce.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 CHEMOTACTICFORCE_HPP_
00029 #define CHEMOTACTICFORCE_HPP_
00030 
00031 #include "ChasteSerialization.hpp"
00032 #include <boost/serialization/base_object.hpp>
00033 
00034 #include "AbstractForce.hpp"
00035 
00036 // Needed here to avoid serialization errors (on Boost<1.37)
00037 #include "CellLabel.hpp"
00038 
00042 template<unsigned DIM>
00043 class ChemotacticForce  : public AbstractForce<DIM>
00044 {
00045 friend class TestForces;
00046 
00047 private:
00048 
00055     double GetChemotacticForceMagnitude(const double concentration, const double concentrationGradientMagnitude);
00056 
00057     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<AbstractForce<DIM> >(*this);
00064     }
00065 
00066 public:
00067 
00071     ChemotacticForce();
00072 
00076     ~ChemotacticForce();
00077 
00087     void AddForceContribution(std::vector<c_vector<double, DIM> >& rForces,
00088                               AbstractCellPopulation<DIM>& rCellPopulation);
00089 
00095     void OutputForceParameters(out_stream& rParamsFile);
00096 };
00097 
00098 #include "SerializationExportWrapper.hpp"
00099 
00100 EXPORT_TEMPLATE_CLASS_SAME_DIMS(ChemotacticForce)
00101 
00102 #endif /*CHEMOTACTICFORCE_HPP_*/

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