Chaste  Release::3.4
AbstractTargetAreaModifier.cpp
1 /*
2 
3 Copyright (c) 2005-2016, 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 "AbstractTargetAreaModifier.hpp"
37 
38 template<unsigned DIM>
41  mReferenceTargetArea(1.0)
42 {
43 }
44 
45 template<unsigned DIM>
47 {
48 }
49 
50 template<unsigned DIM>
52 {
53  UpdateTargetAreas(rCellPopulation);
54 }
55 
56 template<unsigned DIM>
57 void AbstractTargetAreaModifier<DIM>::SetupSolve(AbstractCellPopulation<DIM,DIM>& rCellPopulation, std::string outputDirectory)
58 {
59  if (dynamic_cast<VertexBasedCellPopulation<DIM>*>(&rCellPopulation) == NULL)
60  {
61  EXCEPTION("AbstractTargetAreaModifiers are to be used with a VertexBasedCellPopulation only");
62  }
63 
64  /*
65  * We must update CellData in SetupSolve(), otherwise it will not have been
66  * fully initialised by the time we enter the main time loop.
67  */
68  UpdateTargetAreas(rCellPopulation);
69 }
70 
71 template<unsigned DIM>
73 {
74  // Assume that SetupSolve() has already been called, so we must be using a VertexBasedCellPopulation
75 
76  // Loop over the list of cells, rather than using the population iterator, so as to include dead cells
77  for (std::list<CellPtr>::iterator cell_iter = rCellPopulation.rGetCells().begin();
78  cell_iter != rCellPopulation.rGetCells().end();
79  ++cell_iter)
80  {
81  UpdateTargetAreaOfCell(*cell_iter);
82  }
83 }
84 
85 template<unsigned DIM>
87 {
88  return mReferenceTargetArea;
89 }
90 
91 template<unsigned DIM>
93 {
94  assert(referenceTargetArea >= 0.0);
95  mReferenceTargetArea = referenceTargetArea;
96 }
97 
98 template<unsigned DIM>
100 {
101  *rParamsFile << "\t\t\t<ReferenceTargetArea>" << mReferenceTargetArea << "</ReferenceTargetArea>\n";
102 
103  // Next, call method on direct parent class
105 }
106 
107 // Explicit instantiation
108 template class AbstractTargetAreaModifier<1>;
109 template class AbstractTargetAreaModifier<2>;
110 template class AbstractTargetAreaModifier<3>;
virtual void OutputSimulationModifierParameters(out_stream &rParamsFile)
#define EXCEPTION(message)
Definition: Exception.hpp:143
void SetReferenceTargetArea(double referenceTargetArea)
virtual void OutputSimulationModifierParameters(out_stream &rParamsFile)=0
std::list< CellPtr > & rGetCells()
virtual void UpdateAtEndOfTimeStep(AbstractCellPopulation< DIM, DIM > &rCellPopulation)
virtual void SetupSolve(AbstractCellPopulation< DIM, DIM > &rCellPopulation, std::string outputDirectory)
void UpdateTargetAreas(AbstractCellPopulation< DIM, DIM > &rCellPopulation)