File size: 8,901 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::boundBox
Description
A bounding box defined in terms of the points at its extremities.
\*---------------------------------------------------------------------------*/
#ifndef boundBox_H
#define boundBox_H
#include "pointField.H"
#include "faceList.H"
#include "scalable.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class boundBox;
template<class T> class tmp;
bool operator==(const boundBox&, const boundBox&);
bool operator!=(const boundBox&, const boundBox&);
Istream& operator>>(Istream&, boundBox&);
Ostream& operator<<(Ostream&, const boundBox&);
/*---------------------------------------------------------------------------*\
Class boundBox Declaration
\*---------------------------------------------------------------------------*/
class boundBox
{
// Private Data
//- Minimum and maximum describing the bounding box
point min_, max_;
// Private Member Functions
//- Calculate the bounding box from the given points.
// Does parallel communication (doReduce = true)
void calculate(const UList<point>&, const bool doReduce = true);
public:
// Static Data Members
//- A very large boundBox: min/max == -/+ vGreat
static const boundBox greatBox;
//- A very large inverted boundBox: min/max == +/- vGreat
static const boundBox invertedBox;
// Static Member Functions
//- Does the dictionary have a bound box specified in it?
inline static bool found(const dictionary& dict);
// Constructors
//- Construct null, setting points to zero
inline boundBox();
//- Construct from components
inline boundBox(const point& min, const point& max);
//- Construct as the bounding box of the given points
// Does parallel communication (doReduce = true)
boundBox(const UList<point>&, const bool doReduce = true);
//- Construct as the bounding box of the given temporary pointField.
// Does parallel communication (doReduce = true)
boundBox(const tmp<pointField>&, const bool doReduce = true);
//- Construct bounding box as subset of the pointField.
// The indices could be from cell/face etc.
// Does parallel communication (doReduce = true)
boundBox
(
const UList<point>&,
const labelUList& indices,
const bool doReduce = true
);
//- Construct bounding box as subset of the pointField.
// The indices could be from edge/triFace etc.
// Does parallel communication (doReduce = true)
template<unsigned Size>
boundBox
(
const UList<point>&,
const FixedList<label, Size>& indices,
const bool doReduce = true
);
//- Construct from Istream
inline boundBox(Istream&);
//- Construct from dictionary
inline boundBox(const dictionary&);
// Member Functions
// Access
//- Minimum point defining the bounding box
inline const point& min() const;
//- Maximum point defining the bounding box
inline const point& max() const;
//- Minimum point defining the bounding box, non-const access
inline point& min();
//- Maximum point defining the bounding box, non-const access
inline point& max();
//- The midpoint of the bounding box
inline point midpoint() const;
//- The bounding box span (from minimum to maximum)
inline vector span() const;
//- The magnitude of the bounding box span
inline scalar mag() const;
//- The volume of the bound box
inline scalar volume() const;
//- Smallest length/height/width dimension
inline scalar minDim() const;
//- Largest length/height/width dimension
inline scalar maxDim() const;
//- Average length/height/width dimension
inline scalar avgDim() const;
//- Return corner points in an order corresponding to a 'hex' cell
tmp<pointField> points() const;
//- Return faces with correct point order
static faceList faces();
// Manipulate
//- Inflate box by factor*mag(span) in all dimensions
void inflate(const scalar s);
// Query
//- Overlaps/touches boundingBox?
inline bool overlaps(const boundBox&) const;
//- Overlaps boundingSphere (centre + sqr(radius))?
inline bool overlaps(const point&, const scalar radiusSqr) const;
//- Contains point? (inside or on edge)
inline bool contains(const point&) const;
//- Fully contains other boundingBox?
inline bool contains(const boundBox&) const;
//- Contains point? (inside only)
inline bool containsInside(const point&) const;
//- Contains all of the points? (inside or on edge)
bool contains(const UList<point>&) const;
//- Contains all of the points? (inside or on edge)
bool contains
(
const UList<point>&,
const labelUList& indices
) const;
//- Contains all of the points? (inside or on edge)
template<unsigned Size>
bool contains
(
const UList<point>&,
const FixedList<label, Size>& indices
) const;
//- Contains any of the points? (inside or on edge)
bool containsAny(const UList<point>&) const;
//- Contains any of the points? (inside or on edge)
bool containsAny
(
const UList<point>&,
const labelUList& indices
) const;
//- Contains any of the points? (inside or on edge)
template<unsigned Size>
bool containsAny
(
const UList<point>&,
const FixedList<label, Size>& indices
) const;
//- Return the nearest point on the boundBox to the supplied point.
// If point is inside the boundBox then the point is returned
// unchanged.
point nearest(const point&) const;
// Friend Operators
inline friend bool operator==(const boundBox&, const boundBox&);
inline friend bool operator!=(const boundBox&, const boundBox&);
// IOstream operator
friend Istream& operator>>(Istream&, boundBox&);
friend Ostream& operator<<(Ostream&, const boundBox&);
};
//- Data associated with boundBox type are contiguous
template<>
inline bool contiguous<boundBox>() {return contiguous<point>();}
//- A boundBox is scalable
template<>
struct scalable<boundBox> : public std::true_type {};
//- Apply a conversion to a boundBox by applying separately to min and max
template<class ... Args>
void convert(boundBox& bb, const Args& ... args)
{
convert(bb.min(), args ...);
convert(bb.max(), args ...);
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "boundBoxI.H"
#ifdef NoRepository
#include "boundBoxTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|