AbstractTwoBodyInteractionForce.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2009
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 
00036 template<unsigned DIM>
00037 class AbstractTwoBodyInteractionForce : public AbstractForce<DIM>
00038 {
00039     
00040 private :
00041 
00043     friend class boost::serialization::access;
00050     template<class Archive>
00051     void serialize(Archive & archive, const unsigned int version)
00052     {
00053         // If Archive is an output archive, then '&' resolves to '<<'
00054         // If Archive is an input archive, then '&' resolves to '>>'
00055         archive & boost::serialization::base_object<AbstractForce<DIM> >(*this);
00056         archive & mUseCutoffPoint;
00057         archive & mCutoffPoint;
00058     }
00059 
00060 public :
00061     
00065     AbstractTwoBodyInteractionForce();
00066     
00068     bool mUseCutoffPoint;
00069 
00071     double mCutoffPoint;
00072        
00079     void UseCutoffPoint(double cutoffPoint);
00080 
00086     double GetCutoffPoint();
00087 
00099     virtual c_vector<double, DIM> CalculateForceBetweenNodes(unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractTissue<DIM>& rTissue)=0;
00100 
00101 };
00102 
00103 
00104 template<unsigned DIM>
00105 AbstractTwoBodyInteractionForce<DIM>::AbstractTwoBodyInteractionForce()
00106    : AbstractForce<DIM>()
00107 {
00108     mUseCutoffPoint = false;
00109     mCutoffPoint = 1e10;
00110 }
00111 
00112 
00113 template<unsigned DIM>
00114 void AbstractTwoBodyInteractionForce<DIM>::UseCutoffPoint(double cutoffPoint)
00115 {
00116     assert(cutoffPoint > 0.0);
00117     mUseCutoffPoint = true;
00118     mCutoffPoint = cutoffPoint;
00119 }
00120 
00121 template<unsigned DIM>
00122 double AbstractTwoBodyInteractionForce<DIM>::GetCutoffPoint()
00123 {
00124     return mCutoffPoint;
00125 }
00126 
00127 #endif /*ABSTRACTTWOBODYINTERACTIONFORCE_HPP_*/

Generated on Wed Mar 18 12:51:50 2009 for Chaste by  doxygen 1.5.5