Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
MeshBasedCellPopulationWithGhostNodes.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 MESHBASEDCELLPOPULATIONWITHGHOSTNODES_HPP_
37#define MESHBASEDCELLPOPULATIONWITHGHOSTNODES_HPP_
38
40#include <boost/serialization/base_object.hpp>
41#include <boost/serialization/vector.hpp>
42
43#include "MeshBasedCellPopulation.hpp"
44
55template<unsigned DIM>
57{
58private:
59
62
64 std::vector<bool> mIsGhostNode;
65
70
75
80
94 template<class Archive>
95 void serialize(Archive & archive, const unsigned int version)
96 {
97 // This needs to be first so that MeshBasedCellPopulation::Validate() doesn't go mental.
98 archive & mIsGhostNode;
101 archive & mGhostSpringRestLength;
102 archive & boost::serialization::base_object<MeshBasedCellPopulation<DIM, DIM> >(*this);
103 }
104
114 void Validate();
115
116protected:
124
125public:
126
139 std::vector<CellPtr>& rCells,
140 const std::vector<unsigned> locationIndices=std::vector<unsigned>(),
141 bool deleteMesh=false,
142 double ghostCellSpringStiffness=15.0,
143 double ghostGhostSpringStiffness=15.0,
144 double ghostSpringRestLength=1.0);
145
155 double ghostCellSpringStiffness=15.0,
156 double ghostGhostSpringStiffness=15.0,
157 double ghostSpringRestLength=1.0);
158
163
172
181 std::set<unsigned> GetNeighbouringLocationIndices(CellPtr pCell);
182
188 void SetGhostNodes(const std::set<unsigned>& rGhostNodeIndices);
189
194 void ApplyGhostForces();
195
199 std::vector<bool>& rGetGhostNodes();
200
211 bool IsGhostNode(unsigned index);
212
216 std::set<unsigned> GetGhostNodeIndices();
217
221 void RemoveGhostNode(unsigned nodeIndex);
222
229
238 c_vector<double, DIM> CalculateForceBetweenGhostNodes(const unsigned& rNodeAGlobalIndex, const unsigned& rNodeBGlobalIndex);
239
250 CellPtr AddCell(CellPtr pNewCell, CellPtr pParentCell);
251
259 virtual void OpenWritersFiles(OutputFileHandler& rOutputFileHandler);
260
266 virtual void WriteVtkResultsToFile(const std::string& rDirectory);
267
276 void OutputCellPopulationParameters(out_stream& rParamsFile);
277};
278
279
282
283namespace boost
284{
285namespace serialization
286{
290template<class Archive, unsigned DIM>
291inline void save_construct_data(
292 Archive & ar, const MeshBasedCellPopulationWithGhostNodes<DIM> * t, const unsigned int file_version)
293{
294 // Save data required to construct instance
295 const MutableMesh<DIM,DIM>* p_mesh = &(t->rGetMesh());
296 ar & p_mesh;
297}
298
303template<class Archive, unsigned DIM>
304inline void load_construct_data(
305 Archive & ar, MeshBasedCellPopulationWithGhostNodes<DIM> * t, const unsigned int file_version)
306{
307 // Retrieve data from archive required to construct new instance
308 MutableMesh<DIM,DIM>* p_mesh;
309 ar >> p_mesh;
310
311 // Invoke inplace constructor to initialise instance
313}
314}
315} // namespace
316
317#endif /*MESHBASEDCELLPOPULATIONWITHGHOSTNODES_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
std::set< unsigned > GetNeighbouringLocationIndices(CellPtr pCell)
virtual void OpenWritersFiles(OutputFileHandler &rOutputFileHandler)
c_vector< double, DIM > CalculateForceBetweenGhostNodes(const unsigned &rNodeAGlobalIndex, const unsigned &rNodeBGlobalIndex)
virtual void WriteVtkResultsToFile(const std::string &rDirectory)
CellPtr AddCell(CellPtr pNewCell, CellPtr pParentCell)
void SetGhostNodes(const std::set< unsigned > &rGhostNodeIndices)
void serialize(Archive &archive, const unsigned int version)
virtual TetrahedralMesh< DIM, DIM > * GetTetrahedralMeshForPdeModifier()