Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
CryptSimulation2d.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 CRYPTSIMULATION2D_HPP_
37#define CRYPTSIMULATION2D_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include "WntConcentration.hpp"
43#include "OffLatticeSimulation.hpp"
44#include "VertexBasedCellPopulation.hpp"
45#include "CryptSimulationBoundaryCondition.hpp"
46#include "CryptCentreBasedDivisionRule.hpp"
47#include "CryptVertexBasedDivisionRule.hpp"
48
55{
56 // Allow tests to access private members, in order to test computation of private functions e.g. DoCellBirth()
57 friend class TestCryptSimulation2dWithMeshBasedCellPopulation;
58 friend class TestCryptSimulation2dWithVertexBasedCellPopulation;
59
60protected:
61
70 template<class Archive>
71 void serialize(Archive & archive, const unsigned int version)
72 {
73 archive & boost::serialization::base_object<OffLatticeSimulation<2> >(*this);
74
76 archive & p_wnt_wrapper;
77 }
78
84
90 void SetupSolve();
91
92public:
93
103 bool deleteCellPopulationInDestructor=false,
104 bool initialiseCells=true);
105
111 virtual ~CryptSimulation2d();
112
117
123
132 void OutputSimulationParameters(out_stream& rParamsFile);
133};
134
135// Declare identifier for the serializer
138
139namespace boost
140{
141namespace serialization
142{
146template<class Archive>
147inline void save_construct_data(
148 Archive & ar, const CryptSimulation2d * t, const unsigned int file_version)
149{
150 // Save data required to construct instance
151 const AbstractCellPopulation<2>* p_cell_population = &(t->rGetCellPopulation());
152 ar & p_cell_population;
153}
154
158template<class Archive>
159inline void load_construct_data(
160 Archive & ar, CryptSimulation2d * t, const unsigned int file_version)
161{
162 // Retrieve data from archive required to construct new instance
163 AbstractCellPopulation<2>* p_cell_population;
164 ar & p_cell_population;
165
166 // Invoke inplace constructor to initialise instance
167 ::new(t)CryptSimulation2d(*p_cell_population, true, false);
168}
169}
170} // namespace
171
172#endif /*CRYPTSIMULATION2D_HPP_*/
gcov doesn't like this file...
#define CHASTE_CLASS_EXPORT(T)
void OutputSimulationParameters(out_stream &rParamsFile)
void serialize(Archive &archive, const unsigned int version)
friend class boost::serialization::access
SerializableSingleton< SINGLETON_CLASS > * GetSerializationWrapper() const
static WntConcentration * Instance()