Chaste  Release::2017.1
NodeAttributes.cpp
1 /*
2 
3 Copyright (c) 2005-2017, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, 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 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #include <cassert>
37 
38 #include "NodeAttributes.hpp"
39 #include "Exception.hpp"
40 
41 template<unsigned SPACE_DIM>
43  : mAttributes(std::vector<double>()),
44  mRegion(0u),
45  mAppliedForce(zero_vector<double>(SPACE_DIM)),
46  mRadius(0.0),
47  mNeighbourIndices(std::vector<unsigned>()),
48  mNeighboursSetUp(false),
49  mIsParticle(false)
50 {
51 }
52 
53 template<unsigned SPACE_DIM>
55 {
56  return mAttributes;
57 }
58 
59 template<unsigned SPACE_DIM>
61 {
62  mAttributes.push_back(attribute);
63 }
64 
65 template<unsigned SPACE_DIM>
67 {
68  return mRegion;
69 }
70 
71 template<unsigned SPACE_DIM>
73 {
74  mRegion = region;
75 }
76 
77 template<unsigned SPACE_DIM>
78 c_vector<double, SPACE_DIM>& NodeAttributes<SPACE_DIM>::rGetAppliedForce()
79 {
80  return mAppliedForce;
81 }
82 
83 template<unsigned SPACE_DIM>
84 void NodeAttributes<SPACE_DIM>::AddAppliedForceContribution(const c_vector<double, SPACE_DIM>& rForceContribution)
85 {
86  mAppliedForce += rForceContribution;
87 }
88 
89 template<unsigned SPACE_DIM>
91 {
92  for (unsigned d = 0; d < SPACE_DIM; d++)
93  {
94  mAppliedForce[d] = 0.0;
95  }
96 }
97 
98 template<unsigned SPACE_DIM>
100 {
101  mNeighbourIndices.push_back(index);
102 }
103 
104 template<unsigned SPACE_DIM>
106 {
107  mNeighbourIndices.clear();
108 }
109 
110 template<unsigned SPACE_DIM>
112 {
113  sort( mNeighbourIndices.begin(), mNeighbourIndices.end() );
114  mNeighbourIndices.erase( unique( mNeighbourIndices.begin(), mNeighbourIndices.end() ), mNeighbourIndices.end() );
115 }
116 
117 template<unsigned SPACE_DIM>
119 {
120  return mNeighbourIndices.empty();
121 }
122 
123 template<unsigned SPACE_DIM>
125 {
126  mNeighboursSetUp = flag;
127 };
128 
129 template<unsigned SPACE_DIM>
131 {
132  return mNeighboursSetUp;
133 };
134 
135 template<unsigned SPACE_DIM>
137 {
138  return mNeighbourIndices;
139 };
140 
141 
142 template<unsigned SPACE_DIM>
144 {
145  return mIsParticle;
146 }
147 
148 template<unsigned SPACE_DIM>
150 {
151  mIsParticle = isParticle;
152 }
153 
154 template<unsigned SPACE_DIM>
156 {
157  return mRadius;
158 }
159 
160 template<unsigned SPACE_DIM>
162 {
163  if (radius < 0.0)
164  {
165  EXCEPTION("Trying to set node attributes mRadius to a negative value.");
166  }
167 
168  mRadius = radius;
169 }
170 
171 // Explicit instantiation
172 template class NodeAttributes<1>;
173 template class NodeAttributes<2>;
174 template class NodeAttributes<3>;
unsigned GetRegion()
void SetRegion(unsigned region)
void RemoveDuplicateNeighbours()
#define EXCEPTION(message)
Definition: Exception.hpp:143
void SetRadius(double radius)
std::vector< unsigned > mNeighbourIndices
void SetNeighboursSetUp(bool flag)
void SetIsParticle(bool isParticle)
void AddAttribute(double attribute)
c_vector< double, SPACE_DIM > & rGetAppliedForce()
void ClearAppliedForce()
std::vector< double > mAttributes
std::vector< unsigned > & rGetNeighbours()
std::vector< double > & rGetAttributes()
void AddNeighbour(unsigned index)
c_vector< double, SPACE_DIM > mAppliedForce
void AddAppliedForceContribution(const c_vector< double, SPACE_DIM > &rForceContribution)