AbstractOffLatticeCellPopulation.cpp

00001 /*
00002 
00003 Copyright (c) 2005-2015, University of Oxford.
00004 All rights reserved.
00005 
00006 University of Oxford means the Chancellor, Masters and Scholars of the
00007 University of Oxford, having an administrative office at Wellington
00008 Square, Oxford OX1 2JD, UK.
00009 
00010 This file is part of Chaste.
00011 
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019  * Neither the name of the University of Oxford nor the names of its
00020    contributors may be used to endorse or promote products derived from this
00021    software without specific prior written permission.
00022 
00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 
00036 #include "AbstractOffLatticeCellPopulation.hpp"
00037 
00038 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00039 AbstractOffLatticeCellPopulation<ELEMENT_DIM, SPACE_DIM>::AbstractOffLatticeCellPopulation( AbstractMesh<ELEMENT_DIM, SPACE_DIM>& rMesh,
00040                                                                     std::vector<CellPtr>& rCells,
00041                                                                     const std::vector<unsigned> locationIndices)
00042     : AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>(rMesh, rCells, locationIndices),
00043       mDampingConstantNormal(1.0),
00044       mDampingConstantMutant(1.0),
00045       mAbsoluteMovementThreshold(2.0)
00046 {
00047 }
00048 
00049 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00050 AbstractOffLatticeCellPopulation<ELEMENT_DIM, SPACE_DIM>::AbstractOffLatticeCellPopulation(AbstractMesh<ELEMENT_DIM, SPACE_DIM>& rMesh)
00051     : AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>(rMesh)
00052 {
00053 }
00054 
00055 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00056 void AbstractOffLatticeCellPopulation<ELEMENT_DIM, SPACE_DIM>::SetDampingConstantNormal(double dampingConstantNormal)
00057 {
00058     assert(dampingConstantNormal > 0.0);
00059     mDampingConstantNormal = dampingConstantNormal;
00060 }
00061 
00062 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00063 void AbstractOffLatticeCellPopulation<ELEMENT_DIM, SPACE_DIM>::SetDampingConstantMutant(double dampingConstantMutant)
00064 {
00065     assert(dampingConstantMutant > 0.0);
00066     mDampingConstantMutant = dampingConstantMutant;
00067 }
00068 
00069 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00070 void AbstractOffLatticeCellPopulation<ELEMENT_DIM, SPACE_DIM>::SetAbsoluteMovementThreshold(double absoluteMovementThreshold)
00071 {
00072     mAbsoluteMovementThreshold = absoluteMovementThreshold;
00073 }
00074 
00075 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00076 double AbstractOffLatticeCellPopulation<ELEMENT_DIM, SPACE_DIM>::GetDampingConstantNormal()
00077 {
00078     return mDampingConstantNormal;
00079 }
00080 
00081 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00082 double AbstractOffLatticeCellPopulation<ELEMENT_DIM, SPACE_DIM>::GetDampingConstantMutant()
00083 {
00084     return mDampingConstantMutant;
00085 }
00086 
00087 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00088 double AbstractOffLatticeCellPopulation<ELEMENT_DIM, SPACE_DIM>::GetAbsoluteMovementThreshold()
00089 {
00090     return mAbsoluteMovementThreshold;
00091 }
00092 
00093 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00094 void AbstractOffLatticeCellPopulation<ELEMENT_DIM, SPACE_DIM>::OutputCellPopulationParameters(out_stream& rParamsFile)
00095 {
00096     *rParamsFile << "\t\t<DampingConstantNormal>" << mDampingConstantNormal << "</DampingConstantNormal>\n";
00097     *rParamsFile << "\t\t<DampingConstantMutant>" << mDampingConstantMutant << "</DampingConstantMutant>\n";
00098 
00099     // Call method on direct parent class
00100     AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>::OutputCellPopulationParameters(rParamsFile);
00101 }
00102 
00104 // Explicit instantiation
00106 
00107 template class AbstractOffLatticeCellPopulation<1,1>;
00108 template class AbstractOffLatticeCellPopulation<1,2>;
00109 template class AbstractOffLatticeCellPopulation<2,2>;
00110 template class AbstractOffLatticeCellPopulation<1,3>;
00111 template class AbstractOffLatticeCellPopulation<2,3>;
00112 template class AbstractOffLatticeCellPopulation<3,3>;