Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
NodeAttributes.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 _NODEATTRIBUTES_HPP_
37#define _NODEATTRIBUTES_HPP_
38
41#include <boost/serialization/vector.hpp>
42
46template<unsigned SPACE_DIM>
48{
49private:
50
52 std::vector<double> mAttributes;
53
55 unsigned mRegion;
56
58 c_vector<double, SPACE_DIM> mAppliedForce;
59
61 double mRadius;
62
64 std::vector<unsigned> mNeighbourIndices;
65
68
71
74
81 template<class Archive>
82 void serialize(Archive & archive, const unsigned int version)
83 {
84 archive & mAttributes;
85 archive & mRegion;
86 archive & mRadius;
87 archive & mNeighbourIndices;
88 archive & mNeighboursSetUp;
89 archive & mIsParticle;
90
91 for (unsigned d = 0; d < SPACE_DIM; d++)
92 {
93 archive & mAppliedForce[d];
94 }
95 }
96
97public:
98
103
107 std::vector<double>& rGetAttributes();
108
114 void AddAttribute(double attribute);
115
121 unsigned GetRegion();
122
128 void SetRegion(unsigned region);
129
135 c_vector<double, SPACE_DIM>& rGetAppliedForce();
136
142 void AddAppliedForceContribution(const c_vector<double, SPACE_DIM>& rForceContribution);
143
147 void ClearAppliedForce();
148
154 void AddNeighbour(unsigned index);
155
159 void ClearNeighbours();
160
165
171 bool NeighboursIsEmpty();
172
178 void SetNeighboursSetUp(bool flag);
179
183 bool GetNeighboursSetUp();
184
188 std::vector<unsigned>& rGetNeighbours();
189
195 bool IsParticle();
196
201 void SetIsParticle(bool isParticle);
202
208 double GetRadius();
209
215 void SetRadius(double radius);
216};
217
218#endif //_NODEATTRIBUTES_HPP_
std::vector< double > & rGetAttributes()
c_vector< double, SPACE_DIM > mAppliedForce
void serialize(Archive &archive, const unsigned int version)
void SetRegion(unsigned region)
void RemoveDuplicateNeighbours()
void SetNeighboursSetUp(bool flag)
unsigned GetRegion()
std::vector< unsigned > & rGetNeighbours()
void SetRadius(double radius)
void AddAttribute(double attribute)
std::vector< double > mAttributes
void AddAppliedForceContribution(const c_vector< double, SPACE_DIM > &rForceContribution)
void SetIsParticle(bool isParticle)
friend class boost::serialization::access
std::vector< unsigned > mNeighbourIndices
c_vector< double, SPACE_DIM > & rGetAppliedForce()
void AddNeighbour(unsigned index)