NagaiHondaForce.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 NAGAIHONDAFORCE_HPP_
00029 #define NAGAIHONDAFORCE_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 #include <iostream>
00039 
00049 template<unsigned DIM>
00050 class NagaiHondaForce  : public AbstractForce<DIM>
00051 {
00052 friend class TestForces;
00053 
00054 private:
00055 
00059     double mNagaiHondaDeformationEnergyParameter;
00060 
00064     double mNagaiHondaMembraneSurfaceEnergyParameter;
00065 
00069     double mNagaiHondaCellCellAdhesionEnergyParameter;
00070 
00074     double mNagaiHondaCellBoundaryAdhesionEnergyParameter;
00075 
00079     double mMatureCellTargetArea;
00080 
00081     friend class boost::serialization::access;
00082     template<class Archive>
00083     void serialize(Archive & archive, const unsigned int version)
00084     {
00085         // If Archive is an output archive, then '&' resolves to '<<'
00086         // If Archive is an input archive, then '&' resolves to '>>'
00087         archive & boost::serialization::base_object<AbstractForce<DIM> >(*this);
00088         archive & mNagaiHondaDeformationEnergyParameter;
00089         archive & mNagaiHondaMembraneSurfaceEnergyParameter;
00090         archive & mNagaiHondaCellCellAdhesionEnergyParameter;
00091         archive & mNagaiHondaCellBoundaryAdhesionEnergyParameter;
00092         archive & mMatureCellTargetArea;
00093     }
00094 
00095 public:
00096 
00100     NagaiHondaForce();
00101 
00105     ~NagaiHondaForce();
00106 
00116     void AddForceContribution(std::vector<c_vector<double, DIM> >& rForces, AbstractCellPopulation<DIM>& rCellPopulation);
00117 
00127     virtual double GetAdhesionParameter(Node<DIM>* pNodeA, Node<DIM>* pNodeB, VertexBasedCellPopulation<DIM>& rVertexCellPopulation);
00128 
00132     double GetNagaiHondaDeformationEnergyParameter();
00133 
00137     double GetNagaiHondaMembraneSurfaceEnergyParameter();
00138 
00142     double GetNagaiHondaCellCellAdhesionEnergyParameter();
00143 
00147     double GetNagaiHondaCellBoundaryAdhesionEnergyParameter();
00148 
00154     void SetNagaiHondaDeformationEnergyParameter(double nagaiHondaDeformationEnergyParameter);
00155 
00161     void SetNagaiHondaMembraneSurfaceEnergyParameter(double nagaiHondaMembraneSurfaceEnergyParameter);
00162 
00168     void SetNagaiHondaCellCellAdhesionEnergyParameter(double nagaiHondaCellCellAdhesionEnergyEnergyParameter);
00169 
00175     void SetNagaiHondaCellBoundaryAdhesionEnergyParameter(double nagaiHondaCellBoundaryAdhesionEnergyParameter);
00176 
00186     double GetTargetAreaOfCell(const CellPtr pCell) const;
00187 
00191     double GetMatureCellTargetArea() const;
00192 
00198     void SetMatureCellTargetArea(double matureCellTargetArea);
00199 
00208     void OutputForceParameters(out_stream& rParamsFile);
00209 };
00210 
00211 
00212 #include "SerializationExportWrapper.hpp"
00213 
00214 EXPORT_TEMPLATE_CLASS_SAME_DIMS(NagaiHondaForce)
00215 
00216 #endif /*NAGAIHONDAFORCE_HPP_*/

Generated on Mon Apr 18 11:35:27 2011 for Chaste by  doxygen 1.5.5