Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
ObsoleteBoxCollection.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#ifndef OBSOLETEBOXCOLLECTION_HPP_
36#define OBSOLETEBOXCOLLECTION_HPP_
37
38#include "Node.hpp"
39#include "Element.hpp"
40#include "Box.hpp"
41#include <map>
42#include <vector>
43
44
51template<unsigned DIM>
53{
54private:
55 friend class TestObsoleteBoxCollection;
56
58 std::vector< Box<DIM> > mBoxes;
59
61 c_vector<double, 2*DIM> mDomainSize;
62
64 double mBoxWidth;
65
67 c_vector<unsigned, DIM> mNumBoxesEachDirection;
68
70 std::vector< std::set<unsigned> > mLocalBoxes;
71
73 c_vector<bool, DIM> mIsDomainPeriodic;
74
76 static const double msFudge;
77
82 unsigned GetLinearIndex(c_vector<int, DIM> gridIndices);
83
88 c_vector<unsigned, DIM> GetGridIndices(unsigned linearIndex);
89
94 bool IsBoxInDomain(c_vector<unsigned, DIM> gridIndices);
95
104 c_vector<bool,DIM> IsIndexPenultimate(c_vector<unsigned, DIM> gridIndices);
105
115 void SetupLocalBoxes(const std::vector<c_vector<int, DIM> >& rNeighbours);
116
117public:
118
128 ObsoleteBoxCollection(double boxWidth,
129 c_vector<double, 2*DIM> domainSize,
130 bool isPeriodicInX = false,
131 bool isPeriodicInY = false,
132 bool isPeriodicInZ = false);
133
137 void EmptyBoxes();
138
143 unsigned CalculateContainingBox(Node<DIM>* pNode);
144
149 unsigned CalculateContainingBox(c_vector<double, DIM>& rLocation);
150
155 Box<DIM>& rGetBox(unsigned boxIndex);
156
160 unsigned GetNumBoxes();
161
168
173 void SetupAllLocalBoxes();
174
181 std::set<unsigned>& rGetLocalBoxes(unsigned boxIndex);
182
188 const c_vector<double, 2*DIM>& rGetDomainSize() const;
189
199 void CalculateNodePairs(const std::vector<Node<DIM>*>& rNodes,
200 std::vector<std::pair<Node<DIM>*, Node<DIM>*> >& rNodePairs);
201
211 bool IsOwned(Node<DIM>* pNode)
212 {
213 return true;
214 }
215
224 bool IsBoxOwned(unsigned globalIndex)
225 {
226 return true;
227 }
228};
229
230#endif /*OBSOLETEBOXCOLLECTION_HPP_*/
Definition Box.hpp:51
Definition Node.hpp:59
bool IsBoxInDomain(c_vector< unsigned, DIM > gridIndices)
std::vector< Box< DIM > > mBoxes
c_vector< double, 2 *DIM > mDomainSize
void SetupLocalBoxes(const std::vector< c_vector< int, DIM > > &rNeighbours)
c_vector< bool, DIM > mIsDomainPeriodic
Box< DIM > & rGetBox(unsigned boxIndex)
c_vector< unsigned, DIM > GetGridIndices(unsigned linearIndex)
void CalculateNodePairs(const std::vector< Node< DIM > * > &rNodes, std::vector< std::pair< Node< DIM > *, Node< DIM > * > > &rNodePairs)
bool IsBoxOwned(unsigned globalIndex)
c_vector< unsigned, DIM > mNumBoxesEachDirection
c_vector< bool, DIM > IsIndexPenultimate(c_vector< unsigned, DIM > gridIndices)
std::set< unsigned > & rGetLocalBoxes(unsigned boxIndex)
unsigned GetLinearIndex(c_vector< int, DIM > gridIndices)
bool IsOwned(Node< DIM > *pNode)
const c_vector< double, 2 *DIM > & rGetDomainSize() const
std::vector< std::set< unsigned > > mLocalBoxes
unsigned CalculateContainingBox(Node< DIM > *pNode)