Chaste  Release::3.4
VolumeTrackingModifier.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 "VolumeTrackingModifier.hpp"
37 #include "MeshBasedCellPopulation.hpp"
38 
39 template<unsigned DIM>
42 {
43 }
44 
45 template<unsigned DIM>
47 {
48 }
49 
50 template<unsigned DIM>
52 {
53  UpdateCellData(rCellPopulation);
54 }
55 
56 template<unsigned DIM>
57 void VolumeTrackingModifier<DIM>::SetupSolve(AbstractCellPopulation<DIM,DIM>& rCellPopulation, std::string outputDirectory)
58 {
59  /*
60  * We must update CellData in SetupSolve(), otherwise it will not have been
61  * fully initialised by the time we enter the main time loop.
62  */
63  UpdateCellData(rCellPopulation);
64 }
65 
66 template<unsigned DIM>
68 {
69  // Make sure the cell population is updated
70  rCellPopulation.Update();
71 
81  if (bool(dynamic_cast<MeshBasedCellPopulation<DIM>*>(&rCellPopulation)))
82  {
83  static_cast<MeshBasedCellPopulation<DIM>*>(&(rCellPopulation))->CreateVoronoiTessellation();
84  }
85 
86  // Iterate over cell population
87  for (typename AbstractCellPopulation<DIM>::Iterator cell_iter = rCellPopulation.Begin();
88  cell_iter != rCellPopulation.End();
89  ++cell_iter)
90  {
91  // Get the volume of this cell
92  double cell_volume = rCellPopulation.GetVolumeOfCell(*cell_iter);
93 
94  // Store the cell's volume in CellData
95  cell_iter->GetCellData()->SetItem("volume", cell_volume);
96  }
97 }
98 
99 template<unsigned DIM>
101 {
102  // No parameters to output, so just call method on direct parent class
104 }
105 
106 // Explicit instantiation
107 template class VolumeTrackingModifier<1>;
108 template class VolumeTrackingModifier<2>;
109 template class VolumeTrackingModifier<3>;
110 
111 // Serialization for Boost >= 1.36
114 
virtual void UpdateAtEndOfTimeStep(AbstractCellPopulation< DIM, DIM > &rCellPopulation)
virtual void OutputSimulationModifierParameters(out_stream &rParamsFile)=0
virtual void SetupSolve(AbstractCellPopulation< DIM, DIM > &rCellPopulation, std::string outputDirectory)
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
void OutputSimulationModifierParameters(out_stream &rParamsFile)
virtual void Update(bool hasHadBirthsOrDeaths=true)=0
virtual double GetVolumeOfCell(CellPtr pCell)=0
void UpdateCellData(AbstractCellPopulation< DIM, DIM > &rCellPopulation)