AbstractTwoBodyInteractionForce.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2010
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 ABSTRACTTWOBODYINTERACTIONFORCE_HPP_
00029 #define ABSTRACTTWOBODYINTERACTIONFORCE_HPP_
00030 
00031 #include "AbstractForce.hpp"
00032 #include "MeshBasedCellPopulation.hpp"
00033 #include "NodeBasedCellPopulation.hpp"
00037 template<unsigned DIM>
00038 class AbstractTwoBodyInteractionForce : public AbstractForce<DIM>
00039 {
00040 
00041 private :
00042 
00044     friend class boost::serialization::access;
00051     template<class Archive>
00052     void serialize(Archive & archive, const unsigned int version)
00053     {
00054         // If Archive is an output archive, then '&' resolves to '<<'
00055         // If Archive is an input archive, then '&' resolves to '>>'
00056         archive & boost::serialization::base_object<AbstractForce<DIM> >(*this);
00057         archive & mUseCutOffLength;
00058         archive & mMechanicsCutOffLength;
00059     }
00060 
00061 protected:
00063     bool mUseCutOffLength;
00064 
00068     double mMechanicsCutOffLength;
00069 
00070 public :
00071 
00075     AbstractTwoBodyInteractionForce();
00076 
00082     bool GetUseCutOffLength();
00083 
00090     void SetCutOffLength(double cutOffLength);
00091 
00097     double GetCutOffLength();
00098 
00110     virtual c_vector<double, DIM> CalculateForceBetweenNodes(unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation<DIM>& rCellPopulation)=0;
00111 
00112 
00119     void AddForceContribution(std::vector<c_vector<double, DIM> >& rForces,
00120                               AbstractCellPopulation<DIM>& rCellPopulation);
00121 
00130     virtual void OutputForceParameters(out_stream& rParamsFile);
00131 };
00132 
00133 #endif /*ABSTRACTTWOBODYINTERACTIONFORCE_HPP_*/

Generated on Mon Nov 1 12:35:16 2010 for Chaste by  doxygen 1.5.5