Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
NodeBasedCellPopulationWithParticles.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 NODEBASEDCELLPOPULATIONWITHPARTICLES_HPP_
37#define NODEBASEDCELLPOPULATIONWITHPARTICLES_HPP_
38
39#include "NodeBasedCellPopulation.hpp"
40#include "NodesOnlyMesh.hpp"
41
43#include <boost/serialization/base_object.hpp>
44
49template<unsigned DIM>
51{
52 friend class TestNodeBasedCellPopulationWithParticles;
53
54protected:
58 void Validate();
59
67
68private:
69
75 void SetParticles(const std::set<unsigned>& rParticleIndices);
76
88 template<class Archive>
89 void serialize(Archive & archive, const unsigned int version)
90 {
91 archive & boost::serialization::base_object<NodeBasedCellPopulation<DIM> >(*this);
92 }
93
94public:
95
107 std::vector<CellPtr>& rCells,
108 const std::vector<unsigned> locationIndices=std::vector<unsigned>(),
109 bool deleteMesh=false);
110
117
118
125
135 bool IsParticle(unsigned index);
136
140 std::set<unsigned> GetParticleIndices();
141
152 CellPtr AddCell(CellPtr pNewCell, CellPtr pParentCell);
153
159 virtual void WriteVtkResultsToFile(const std::string& rDirectory);
160
169 void OutputCellPopulationParameters(out_stream& rParamsFile);
170};
171
174
175namespace boost
176{
177namespace serialization
178{
182template<class Archive, unsigned DIM>
183inline void save_construct_data(
184 Archive & ar, const NodeBasedCellPopulationWithParticles<DIM> * t, const unsigned int file_version)
185{
186 // Save data required to construct instance
187 const NodesOnlyMesh<DIM>* p_mesh = &(t->rGetMesh());
188 ar & p_mesh;
189}
190
195template<class Archive, unsigned DIM>
196inline void load_construct_data(
197 Archive & ar, NodeBasedCellPopulationWithParticles<DIM> * t, const unsigned int file_version)
198{
199 // Retrieve data from archive required to construct new instance
200 NodesOnlyMesh<DIM>* p_mesh;
201 ar >> p_mesh;
202
203 // Invoke inplace constructor to initialise instance
205}
206}
207} // namespace ...
208
209#endif /*NODEBASEDCELLPOPULATIONWITHPARTICLES_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
CellPtr AddCell(CellPtr pNewCell, CellPtr pParentCell)
virtual void WriteVtkResultsToFile(const std::string &rDirectory)
void serialize(Archive &archive, const unsigned int version)
void SetParticles(const std::set< unsigned > &rParticleIndices)