Chaste Commit::ca8ccdedf819b6e02855bc0e8e6f50bdecbc5208
AbstractCaBasedDivisionRule.hpp
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#ifndef ABSTRACTCABASEDDIVISIONRULE_HPP_
37#define ABSTRACTCABASEDDIVISIONRULE_HPP_
38
39#include "CaBasedCellPopulation.hpp"
40
42#include "ClassIsAbstract.hpp"
43
44// Forward declaration prevents circular include chain
45template<unsigned SPACE_DIM> class CaBasedCellPopulation;
46
54template<unsigned SPACE_DIM>
56{
57private:
58
59 friend class boost::serialization::access;
66 template<class Archive>
67 void serialize(Archive & archive, const unsigned int version)
68 {
69 }
70
71protected:
72
80 virtual void OutputCellCaBasedDivisionRuleParameters(out_stream& rParamsFile);
81
82public:
87
92
103 virtual bool IsRoomToDivide(CellPtr pParentCell,
104 CaBasedCellPopulation<SPACE_DIM>& rCellPopulation)=0;
105
118 virtual unsigned CalculateDaughterNodeIndex(CellPtr pNewCell,
119 CellPtr pParentCell,
120 CaBasedCellPopulation<SPACE_DIM>& rCellPopulation)=0;
121
127 void OutputCellCaBasedDivisionRuleInfo(out_stream& rParamsFile);
128};
129
131
132#endif /*ABSTRACTCaBASEDDIVISIONRULE_HPP_*/
#define TEMPLATED_CLASS_IS_ABSTRACT_1_UNSIGNED(T)
virtual unsigned CalculateDaughterNodeIndex(CellPtr pNewCell, CellPtr pParentCell, CaBasedCellPopulation< SPACE_DIM > &rCellPopulation)=0
void serialize(Archive &archive, const unsigned int version)
virtual void OutputCellCaBasedDivisionRuleParameters(out_stream &rParamsFile)
virtual bool IsRoomToDivide(CellPtr pParentCell, CaBasedCellPopulation< SPACE_DIM > &rCellPopulation)=0
void OutputCellCaBasedDivisionRuleInfo(out_stream &rParamsFile)