Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
PlaneBasedCellKiller.cpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#include "PlaneBasedCellKiller.hpp"
37
38template<unsigned DIM>
40 c_vector<double, DIM> point,
41 c_vector<double, DIM> normal)
42 : AbstractCellKiller<DIM>(pCellPopulation),
43 mPointOnPlane(point)
44{
45 assert(norm_2(normal) > 0.0);
46 mNormalToPlane = normal/norm_2(normal);
47}
48
49template<unsigned DIM>
50const c_vector<double, DIM>& PlaneBasedCellKiller<DIM>::rGetPointOnPlane() const
51{
52 return mPointOnPlane;
53}
54
55template<unsigned DIM>
56const c_vector<double, DIM>& PlaneBasedCellKiller<DIM>::rGetNormalToPlane() const
57{
58 return mNormalToPlane;
59}
60
61template<unsigned DIM>
63{
64 for (typename AbstractCellPopulation<DIM>::Iterator cell_iter = this->mpCellPopulation->Begin();
65 cell_iter != this->mpCellPopulation->End();
66 ++cell_iter)
67 {
68 c_vector<double, DIM> cell_location = this->mpCellPopulation->GetLocationOfCellCentre(*cell_iter);
69
70 if (inner_prod(cell_location - mPointOnPlane, mNormalToPlane) > 0.0)
71 {
72 // Mark the cell as killed and store removal information if required.
73 this->mpCellPopulation->KillCell(*cell_iter, "PlaneBasedCellKiller");
74 }
75 }
76}
77
78template<unsigned DIM>
80{
81 *rParamsFile << "\t\t\t<PointOnPlane>";
82 for (unsigned index=0; index != DIM-1U; index++) //Note: inequality avoids testing index < 0U when DIM=1
83 {
84 *rParamsFile << mPointOnPlane[index] << ",";
85 }
86 *rParamsFile << mPointOnPlane[DIM-1] << "</PointOnPlane>\n";
87
88 *rParamsFile << "\t\t\t<NormalToPlane>";
89 for (unsigned index=0; index != DIM-1U; index++) //Note: inequality avoids testing index < 0U when DIM=1
90 {
91 *rParamsFile << mNormalToPlane[index] << ",";
92 }
93 *rParamsFile << mNormalToPlane[DIM-1] << "</NormalToPlane>\n";
94
95 // Call method on direct parent class
97}
98
99// Explicit instantiation
100template class PlaneBasedCellKiller<1>;
101template class PlaneBasedCellKiller<2>;
102template class PlaneBasedCellKiller<3>;
103
104// Serialization for Boost >= 1.36
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
virtual void OutputCellKillerParameters(out_stream &rParamsFile)=0
void OutputCellKillerParameters(out_stream &rParamsFile)
const c_vector< double, DIM > & rGetNormalToPlane() const
c_vector< double, DIM > mNormalToPlane
PlaneBasedCellKiller(AbstractCellPopulation< DIM > *pCellPopulation, c_vector< double, DIM > point, c_vector< double, DIM > normal)
const c_vector< double, DIM > & rGetPointOnPlane() const
virtual void CheckAndLabelCellsForApoptosisOrDeath()