Chaste  Release::3.4
BoxCollection.hpp
1 /*
2 
3 Copyright (c) 2005-2016, 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 #ifndef BOXCOLLECTION_HPP_
36 #define BOXCOLLECTION_HPP_
37 
38 #include "Node.hpp"
39 #include "Element.hpp"
40 #include "Box.hpp"
41 #include <map>
42 
47 template<unsigned DIM>
49 {
50 private:
51  friend class TestBoxCollection;
52 
54  std::vector< Box<DIM> > mBoxes;
55 
57  c_vector<double, 2*DIM> mDomainSize;
58 
60  double mBoxWidth;
61 
63  c_vector<unsigned, DIM> mNumBoxesEachDirection;
64 
66  std::vector< std::set<unsigned> > mLocalBoxes;
67 
69  c_vector<bool, DIM> mIsDomainPeriodic;
70 
72  static const double msFudge;
73 
78  unsigned GetLinearIndex(c_vector<int,DIM> gridIndices);
79 
84  c_vector<int,DIM> GetGridIndices(unsigned linearIndex);
85 
90  bool IsBoxInDomain(c_vector<int,DIM> gridIndices);
91 
100  c_vector<bool,DIM> IsIndexPenultimate(c_vector<int,DIM> gridIndices);
101 
111  void SetupLocalBoxes(std::vector<c_vector<int, DIM> > neighbours);
112 
113 public:
114 
124  BoxCollection(double boxWidth,
125  c_vector<double, 2*DIM> domainSize,
126  bool isPeriodicInX = false,
127  bool isPeriodicInY = false,
128  bool isPeriodicInZ = false);
129 
133  void EmptyBoxes();
134 
139  unsigned CalculateContainingBox(Node<DIM>* pNode);
140 
145  unsigned CalculateContainingBox(c_vector<double, DIM>& rLocation);
146 
151  Box<DIM>& rGetBox(unsigned boxIndex);
152 
156  unsigned GetNumBoxes();
157 
164 
169  void SetupAllLocalBoxes();
170 
175  std::set<unsigned> GetLocalBoxes(unsigned boxIndex);
176 
182  const c_vector<double, 2*DIM>& rGetDomainSize() const;
183 
194  void CalculateNodePairs(std::vector<Node<DIM>*>& rNodes,
195  std::vector<std::pair<Node<DIM>*, Node<DIM>*> >& rNodePairs,
196  std::map<unsigned, std::set<unsigned> >& rNodeNeighbours);
197 };
198 
199 #endif /*BOXCOLLECTION_HPP_*/
Definition: Node.hpp:58
c_vector< int, DIM > GetGridIndices(unsigned linearIndex)
std::vector< Box< DIM > > mBoxes
std::set< unsigned > GetLocalBoxes(unsigned boxIndex)
unsigned GetLinearIndex(c_vector< int, DIM > gridIndices)
unsigned GetNumBoxes()
c_vector< bool, DIM > IsIndexPenultimate(c_vector< int, DIM > gridIndices)
bool IsBoxInDomain(c_vector< int, DIM > gridIndices)
unsigned CalculateContainingBox(Node< DIM > *pNode)
Definition: Box.hpp:50
const c_vector< double, 2 *DIM > & rGetDomainSize() const
void SetupAllLocalBoxes()
BoxCollection(double boxWidth, c_vector< double, 2 *DIM > domainSize, bool isPeriodicInX=false, bool isPeriodicInY=false, bool isPeriodicInZ=false)
c_vector< double, 2 *DIM > mDomainSize
Box< DIM > & rGetBox(unsigned boxIndex)
c_vector< unsigned, DIM > mNumBoxesEachDirection
void SetupLocalBoxesHalfOnly()
void CalculateNodePairs(std::vector< Node< DIM > * > &rNodes, std::vector< std::pair< Node< DIM > *, Node< DIM > * > > &rNodePairs, std::map< unsigned, std::set< unsigned > > &rNodeNeighbours)
static const double msFudge
void SetupLocalBoxes(std::vector< c_vector< int, DIM > > neighbours)
c_vector< bool, DIM > mIsDomainPeriodic
std::vector< std::set< unsigned > > mLocalBoxes