Chaste  Release::2018.1
AbstractOffLatticeCellPopulation.cpp
1 /*
2 
3 Copyright (c) 2005-2018, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #include "AbstractOffLatticeCellPopulation.hpp"
37 
38 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
40  std::vector<CellPtr>& rCells,
41  const std::vector<unsigned> locationIndices)
42  : AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>(rMesh, rCells, locationIndices),
43  mDampingConstantNormal(1.0),
44  mDampingConstantMutant(1.0),
45  mAbsoluteMovementThreshold(2.0)
46 {
47 }
48 
49 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
51  : AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>(rMesh)
52 {
53 }
54 
55 // LCOV_EXCL_START
56 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
58 {
59  // This method is deprecated by the NumericalMethod class hierarchy; the only population that calls this method is the NodeBasedCellPopulationWithBuskeUpdate.
61 }
62 // LCOV_EXCL_STOP
63 
64 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
66 {
67  assert(dampingConstantNormal > 0.0);
68  mDampingConstantNormal = dampingConstantNormal;
69 }
70 
71 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
73 {
74  assert(dampingConstantMutant > 0.0);
75  mDampingConstantMutant = dampingConstantMutant;
76 }
77 
78 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
80 {
81  mAbsoluteMovementThreshold = absoluteMovementThreshold;
82 }
83 
84 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
86 {
87  return mDampingConstantNormal;
88 }
89 
90 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
92 {
93  return mDampingConstantMutant;
94 }
95 
96 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
98 {
99  return mAbsoluteMovementThreshold;
100 }
101 
102 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
104 {
105  *rParamsFile << "\t\t<DampingConstantNormal>" << mDampingConstantNormal << "</DampingConstantNormal>\n";
106  *rParamsFile << "\t\t<DampingConstantMutant>" << mDampingConstantMutant << "</DampingConstantMutant>\n";
107 
108  // Call method on direct parent class
110 }
111 
112 // Explicit instantiation
void SetAbsoluteMovementThreshold(double absoluteMovementThreshold)
virtual void OutputCellPopulationParameters(out_stream &rParamsFile)=0
#define NEVER_REACHED
Definition: Exception.hpp:206
void SetDampingConstantNormal(double dampingConstantNormal)
virtual void OutputCellPopulationParameters(out_stream &rParamsFile)
void SetDampingConstantMutant(double dampingConstantMutant)
AbstractOffLatticeCellPopulation(AbstractMesh< ELEMENT_DIM, SPACE_DIM > &rMesh)