Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
PeriodicNodesOnlyMesh.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 PERIODICNODESONLYMESH_HPP_
37#define PERIODICNODESONLYMESH_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include "NodesOnlyMesh.hpp"
43
52template<unsigned SPACE_DIM>
53class PeriodicNodesOnlyMesh: public NodesOnlyMesh<SPACE_DIM>
54{
55private:
59 c_vector<double,SPACE_DIM> mWidth;
60
64 c_vector<bool,SPACE_DIM> mIsDimPeriodic;
65
66 friend class TestPeriodicNodesOnlyMesh;
67
81 template<class Archive>
82 void serialize(Archive & archive, const unsigned int version)
83 {
84 archive & boost::serialization::base_object<NodesOnlyMesh<SPACE_DIM> >(*this);
85 archive & mWidth;
86 archive & mIsDimPeriodic;
87 }
88
89public:
90
97 PeriodicNodesOnlyMesh(c_vector<double,SPACE_DIM> width);
98
107 virtual void SetUpBoxCollection(double cutOffLength, c_vector<double, 2*SPACE_DIM> domainSize, int numLocalRows = PETSC_DECIDE, c_vector<bool,SPACE_DIM> isDimPeriodic = zero_vector<bool>(SPACE_DIM));
108
119 c_vector<double, SPACE_DIM> GetVectorFromAtoB(const c_vector<double, SPACE_DIM>& rLocation1, const c_vector<double, SPACE_DIM>& rLocation2);
120
130 double GetWidth(const unsigned& rDimension) const;
131
136 c_vector<double,SPACE_DIM> GetPeriodicWidths() const;
137
148 void SetNode(unsigned nodeIndex, ChastePoint<SPACE_DIM> point, bool concreteMove = false);
149
156 unsigned AddNode(Node<SPACE_DIM>* pNewNode);
157
164 void RefreshMesh();
165};
166
167namespace boost
168{
169namespace serialization
170{
174template<class Archive, unsigned SPACE_DIM>
175inline void save_construct_data(
176 Archive & ar, const PeriodicNodesOnlyMesh<SPACE_DIM> * t, const unsigned int file_version)
177{
178 // Save data required to construct instance
179 const c_vector<double,SPACE_DIM> width = t->GetPeriodicWidths();
180 for ( unsigned i=0; i < SPACE_DIM; i++ )
181 {
182 ar << width(i);
183 }
184}
185
189template<class Archive, unsigned SPACE_DIM>
190inline void load_construct_data(
191 Archive & ar, PeriodicNodesOnlyMesh<SPACE_DIM> * t, const unsigned int file_version)
192{
193 // Retrieve data from archive required to construct new instance of the mesh
194 c_vector<double,SPACE_DIM> width;
195 for (unsigned i=0; i<SPACE_DIM; i++)
196 {
197 double current_width;
198 ar & current_width;
199 width(i) = current_width;
200 }
201
202 // Invoke inplace constructor to initialise instance
204}
205}
206} // namespace ...
207
210
211#endif /*PERIODICNODESONLYMESH_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
Definition Node.hpp:59
c_vector< double, SPACE_DIM > mWidth
c_vector< bool, SPACE_DIM > mIsDimPeriodic
void SetNode(unsigned nodeIndex, ChastePoint< SPACE_DIM > point, bool concreteMove=false)
void serialize(Archive &archive, const unsigned int version)
unsigned AddNode(Node< SPACE_DIM > *pNewNode)
c_vector< double, SPACE_DIM > GetVectorFromAtoB(const c_vector< double, SPACE_DIM > &rLocation1, const c_vector< double, SPACE_DIM > &rLocation2)
virtual void SetUpBoxCollection(double cutOffLength, c_vector< double, 2 *SPACE_DIM > domainSize, int numLocalRows=PETSC_DECIDE, c_vector< bool, SPACE_DIM > isDimPeriodic=zero_vector< bool >(SPACE_DIM))
c_vector< double, SPACE_DIM > GetPeriodicWidths() const
friend class boost::serialization::access
double GetWidth(const unsigned &rDimension) const