VertexCryptBoundaryForce.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 VERTEXCRYPTBOUNDARYFORCE_HPP_
00029 #define VERTEXCRYPTBOUNDARYFORCE_HPP_
00030 
00031 
00032 #include "ChasteSerialization.hpp"
00033 #include <boost/serialization/base_object.hpp>
00034 
00035 #include "AbstractForce.hpp"
00036 #include "VertexBasedCellPopulation.hpp"
00037 
00038 
00048 template<unsigned DIM>
00049 class VertexCryptBoundaryForce  : public AbstractForce<DIM>
00050 {
00051 friend class TestVertexCryptBoundaryForce;
00052 
00053 private:
00054 
00056     double mForceStrength;
00057 
00058     friend class boost::serialization::access;
00059     template<class Archive>
00060     void serialize(Archive & archive, const unsigned int version)
00061     {
00062         // If Archive is an output archive, then '&' resolves to '<<'
00063         // If Archive is an input archive, then '&' resolves to '>>'
00064         archive & boost::serialization::base_object<AbstractForce<DIM> >(*this);
00065         archive & mForceStrength;
00066     }
00067 
00068 public:
00069 
00075     VertexCryptBoundaryForce(double forceStrength=1.0);
00076 
00080     ~VertexCryptBoundaryForce();
00081 
00090     void AddForceContribution(std::vector<c_vector<double, DIM> >& rForces,
00091                               AbstractCellPopulation<DIM>& rCellPopulation);
00092 
00094     double GetForceStrength() const;
00095 
00104     void OutputForceParameters(out_stream& rParamsFile);
00105 };
00106 
00107 
00108 #include "SerializationExportWrapper.hpp"
00109 
00110 EXPORT_TEMPLATE_CLASS_SAME_DIMS(VertexCryptBoundaryForce)
00111 
00112 #endif /*VERTEXCRYPTBOUNDARYFORCE_HPP_*/

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