Chaste  Release::3.4
AbstractCaBasedDivisionRule.hpp
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 #ifndef ABSTRACTCABASEDDIVISIONRULE_HPP_
37 #define ABSTRACTCABASEDDIVISIONRULE_HPP_
38 
39 #include "CaBasedCellPopulation.hpp"
40 
41 #include "ChasteSerialization.hpp"
42 #include "ClassIsAbstract.hpp"
43 
44 // Forward declaration prevents circular include chain
45 template<unsigned SPACE_DIM> class CaBasedCellPopulation;
46 
54 template<unsigned SPACE_DIM>
56 {
57 private:
58 
59  friend class boost::serialization::access;
66  template<class Archive>
67  void serialize(Archive & archive, const unsigned int version)
68  {
69  }
70 
71 protected:
72 
80  virtual void OutputCellCaBasedDivisionRuleParameters(out_stream& rParamsFile);
81 
82 public:
87 
92 
100  virtual bool IsRoomToDivide(CellPtr pParentCell,
101  CaBasedCellPopulation<SPACE_DIM>& rCellPopulation)=0;
102 
112  virtual unsigned CalculateDaughterNodeIndex(CellPtr pNewCell, CellPtr pParentCell,
113  CaBasedCellPopulation<SPACE_DIM>& rCellPopulation)=0;
114 
120  void OutputCellCaBasedDivisionRuleInfo(out_stream& rParamsFile);
121 };
122 
124 
125 #endif /*ABSTRACTCaBASEDDIVISIONRULE_HPP_*/
void serialize(Archive &archive, const unsigned int version)
#define TEMPLATED_CLASS_IS_ABSTRACT_1_UNSIGNED(T)
virtual unsigned CalculateDaughterNodeIndex(CellPtr pNewCell, CellPtr pParentCell, CaBasedCellPopulation< SPACE_DIM > &rCellPopulation)=0
virtual void OutputCellCaBasedDivisionRuleParameters(out_stream &rParamsFile)
void OutputCellCaBasedDivisionRuleInfo(out_stream &rParamsFile)
virtual bool IsRoomToDivide(CellPtr pParentCell, CaBasedCellPopulation< SPACE_DIM > &rCellPopulation)=0
virtual ~AbstractCaBasedDivisionRule()