mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
1d62b6274e
- useful to have std::reduce(), std::transform_reduce() available in more places, so treat like <algorithm> and include in "stdFoam.H" STYLE: add 'stricter' detection markers for cast of SubList to List etc. STYLE: remove 'const' qualifier from Foam:one/Foam::zero (in Field)
474 lines
16 KiB
C++
474 lines
16 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
Copyright (C) 2017-2023 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
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::treeBoundBox
|
|
|
|
Description
|
|
Standard boundBox with extra functionality for use in octree.
|
|
|
|
Numbering of corner points is according to octant numbering as shown below.
|
|
For vertex numbering in the sequence 0 to 7:
|
|
- faces 0 and 1 are x-min and x-max, respectively;
|
|
- faces 2 and 3 are y-min and y-max, respectively;
|
|
- faces 4 and 5 are z-min and z-max, respectively.
|
|
.
|
|
|
|
\verbatim
|
|
Octant vertex ordering | Hex cell ordering
|
|
(treeBoundBox) | (boundBox, blockMesh, hexCell)
|
|
|
|
|
6 ---- 7 | 7 ---- 6
|
|
f5 |\ :\ f3 | f5 |\ :\ f3
|
|
| | 4 ---- 5 \ | | | 4 ---- 5 \
|
|
| 2.|....3 | \ | | 3.|....2 | \
|
|
| \| \| f2 | | \| \| f2
|
|
f4 0 ---- 1 | f4 0 ---- 1
|
|
Y Z |
|
|
\ | f0 ------ f1 | f0 ------ f1
|
|
\| |
|
|
o--- X |
|
|
\endverbatim
|
|
|
|
Note
|
|
When a bounding box is created without any points, it creates an inverted
|
|
bounding box. Points can be added later and the bounding box will grow to
|
|
include them.
|
|
|
|
SeeAlso
|
|
Foam::boundBox
|
|
|
|
SourceFiles
|
|
treeBoundBoxI.H
|
|
treeBoundBox.C
|
|
treeBoundBoxTemplates.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef Foam_treeBoundBox_H
|
|
#define Foam_treeBoundBox_H
|
|
|
|
#include "boundBox.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward Declarations
|
|
class treeBoundBox;
|
|
|
|
Istream& operator>>(Istream& is, treeBoundBox& bb);
|
|
Ostream& operator<<(Ostream& os, const treeBoundBox& bb);
|
|
|
|
// List types
|
|
typedef List<treeBoundBox> treeBoundBoxList; //!< A List of treeBoundBox
|
|
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class treeBoundBox Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class treeBoundBox
|
|
:
|
|
public boundBox
|
|
{
|
|
public:
|
|
|
|
// Enumerations
|
|
|
|
//- Bits used for octant/point directional encoding.
|
|
// Every octant/corner point is the combination of three directions.
|
|
// Defined as (1 << vector::components).
|
|
enum octantBit : direction
|
|
{
|
|
RIGHTHALF = 1, //!< 1: positive x-direction
|
|
TOPHALF = 2, //!< 2: positive y-direction
|
|
FRONTHALF = 4 //!< 4: positive z-direction
|
|
};
|
|
|
|
//- Face codes. Identical order and meaning as per hex cellmodel
|
|
//- and boundBox, but have a different point ordering.
|
|
// Defined as (2 * vector::components + positive).
|
|
enum faceId : direction
|
|
{
|
|
LEFT = 0, //!< 0: x-min face
|
|
RIGHT = 1, //!< 1: x-max face
|
|
BOTTOM = 2, //!< 2: y-min face
|
|
TOP = 3, //!< 3: y-max face
|
|
BACK = 4, //!< 4: z-min face
|
|
FRONT = 5 //!< 5: z-max face
|
|
};
|
|
|
|
//- Bits used for face encoding.
|
|
// Defined as (1 << (2 * vector::components + positive)).
|
|
// For example, the positive Z-face:
|
|
// (1 << (2 * vector::Z + 1))
|
|
enum faceBit : direction
|
|
{
|
|
NOFACE = 0, //!< 0: none
|
|
LEFTBIT = (1 << LEFT), //!< 1: x-min face
|
|
RIGHTBIT = (1 << RIGHT), //!< 2: x-max face
|
|
BOTTOMBIT = (1 << BOTTOM), //!< 4: y-min face
|
|
TOPBIT = (1 << TOP), //!< 8: y-max face
|
|
BACKBIT = (1 << BACK), //!< 16: z-min face
|
|
FRONTBIT = (1 << FRONT) //!< 32: z-max face
|
|
};
|
|
|
|
//- Edges codes.
|
|
// E01 = edge between 0 and 1.
|
|
enum edgeId
|
|
{
|
|
E01 = 0,
|
|
E13 = 1,
|
|
E23 = 2,
|
|
E02 = 3,
|
|
|
|
E45 = 4,
|
|
E57 = 5,
|
|
E67 = 6,
|
|
E46 = 7,
|
|
|
|
E04 = 8,
|
|
E15 = 9,
|
|
E37 = 10,
|
|
E26 = 11
|
|
};
|
|
|
|
|
|
// Static Data Members
|
|
|
|
//- Face to point addressing, using octant corner points.
|
|
static const faceList faces;
|
|
|
|
//- Edge to point addressing, using octant corner points.
|
|
static const edgeList edges;
|
|
|
|
|
|
// Static Methods
|
|
|
|
//- The null treeBoundBox is the same as an inverted box
|
|
static const treeBoundBox& null() noexcept
|
|
{
|
|
return
|
|
reinterpret_cast<const treeBoundBox&>(boundBox::invertedBox);
|
|
}
|
|
|
|
|
|
// Standard (Generated) Methods
|
|
|
|
//- Default construct: an inverted bounding box
|
|
treeBoundBox() = default;
|
|
|
|
//- Copy construct
|
|
treeBoundBox(const treeBoundBox&) = default;
|
|
|
|
//- Copy assignment
|
|
treeBoundBox& operator=(const treeBoundBox&) = default;
|
|
|
|
//- Copy construct from a boundBox
|
|
explicit treeBoundBox(const boundBox& bb) : boundBox(bb) {}
|
|
|
|
//- Copy assignment from a boundBox
|
|
void operator=(const boundBox& bb)
|
|
{
|
|
static_cast<boundBox&>(*this) = bb;
|
|
}
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct a 0/1 unit bounding box
|
|
inline explicit treeBoundBox(Foam::zero_one);
|
|
|
|
//- Construct a bounding box containing a single initial point
|
|
inline explicit treeBoundBox(const point& p);
|
|
|
|
//- Construct from bound box min/max points
|
|
inline treeBoundBox(const point& min, const point& max);
|
|
|
|
///TBD: Construct from bound box min/max points
|
|
///inline explicit treeBoundBox(const MinMax<point>& bb);
|
|
|
|
//- Construct from bound box min/max points
|
|
inline explicit treeBoundBox(const Pair<point>& bb);
|
|
|
|
//- Construct as the bounding box of the given pointField.
|
|
// Local processor domain only (no reduce as in boundBox)
|
|
explicit treeBoundBox(const UList<point>& points);
|
|
|
|
//- Construct as subset of points
|
|
// Local processor domain only (no reduce as in boundBox)
|
|
treeBoundBox(const UList<point>& points, const labelUList& indices);
|
|
|
|
//- Construct as subset of points
|
|
// The indices could be from edge/triFace etc.
|
|
// Local processor domain only (no reduce as in boundBox)
|
|
template<unsigned N>
|
|
treeBoundBox
|
|
(
|
|
const UList<point>& points,
|
|
const FixedList<label, N>& indices
|
|
);
|
|
|
|
//- Construct from Istream
|
|
inline explicit treeBoundBox(Istream& is);
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
//- Vertex coordinates. In octant coding.
|
|
tmp<pointField> points() const;
|
|
|
|
|
|
// Octant handling
|
|
|
|
//- Corner point of given octant
|
|
inline point corner(const direction octant) const;
|
|
|
|
//- Sub-box of given octant. Midpoint calculated.
|
|
treeBoundBox subBbox(const direction octant) const;
|
|
|
|
//- Sub-box given by octant number. Midpoint provided.
|
|
treeBoundBox subBbox(const point& mid, const direction) const;
|
|
|
|
//- Sub-box half for given face
|
|
treeBoundBox subHalf(const direction whichFace) const;
|
|
|
|
//- Sub-box half for given face with prescribed mid point value.
|
|
//- Eg, subHalf(scalar, LEFT)
|
|
treeBoundBox subHalf
|
|
(
|
|
const scalar mid,
|
|
const direction whichFace
|
|
) const;
|
|
|
|
//- Returns octant number given point and the calculated midpoint.
|
|
inline direction subOctant
|
|
(
|
|
const point& pt
|
|
) const;
|
|
|
|
//- Returns octant number given point and midpoint.
|
|
static inline direction subOctant
|
|
(
|
|
const point& mid,
|
|
const point& pt
|
|
);
|
|
|
|
//- Returns octant number given point and the calculated midpoint.
|
|
// onEdge set if the point is on edge of subOctant
|
|
inline direction subOctant
|
|
(
|
|
const point& pt,
|
|
bool& onEdge
|
|
) const;
|
|
|
|
//- Returns octant number given point and midpoint.
|
|
// onEdge set if the point is on edge of subOctant
|
|
static inline direction subOctant
|
|
(
|
|
const point& mid,
|
|
const point& pt,
|
|
bool& onEdge
|
|
);
|
|
|
|
//- Returns octant number given intersection and midpoint.
|
|
// onEdge set if the point is on edge of subOctant
|
|
// If onEdge, the direction vector determines which octant to use
|
|
// (acc. to which octant the point would be if it were moved
|
|
// along dir)
|
|
static inline direction subOctant
|
|
(
|
|
const point& mid,
|
|
const vector& dir,
|
|
const point& pt,
|
|
bool& onEdge
|
|
);
|
|
|
|
//- Calculates optimal order to look for nearest to point.
|
|
// First will be the octant containing the point,
|
|
// second the octant with boundary nearest to the point etc.
|
|
inline void searchOrder
|
|
(
|
|
const point& pt,
|
|
FixedList<direction, 8>& octantOrder
|
|
) const;
|
|
|
|
//- Return optimal search order to look for nearest to point.
|
|
inline FixedList<direction, 8> searchOrder(const point& pt) const;
|
|
|
|
|
|
// Check
|
|
|
|
//- Overlaps with other bounding box, sphere etc?
|
|
using boundBox::overlaps;
|
|
|
|
//- Does sub-octant overlap/touch boundingBox?
|
|
bool subOverlaps
|
|
(
|
|
const direction octant,
|
|
const boundBox& bb
|
|
) const;
|
|
|
|
//- Does sub-octant overlap boundingSphere (centre + sqr(radius))?
|
|
inline bool subOverlaps
|
|
(
|
|
const direction octant,
|
|
const point& centre,
|
|
const scalar radiusSqr
|
|
) const;
|
|
|
|
//- intersects other bounding box, sphere etc?
|
|
using boundBox::intersects;
|
|
|
|
//- Intersects segment; set point to intersection position and face,
|
|
// return true if intersection found.
|
|
// (pt argument used during calculation even if not intersecting).
|
|
// Calculates intersections from outside supplied vector
|
|
// (overallStart, overallVec). This is so when
|
|
// e.g. tracking through lots of consecutive boxes
|
|
// (typical octree) we're not accumulating truncation errors. Set
|
|
// to start, (end-start) if not used.
|
|
bool intersects
|
|
(
|
|
const point& overallStart,
|
|
const vector& overallVec,
|
|
const point& start,
|
|
const point& end,
|
|
point& pt,
|
|
direction& ptBits
|
|
) const;
|
|
|
|
//- Like above but does not return faces point is on
|
|
bool intersects
|
|
(
|
|
const point& start,
|
|
const point& end,
|
|
point& pt
|
|
) const;
|
|
|
|
//- Like above but does not return faces point is on
|
|
inline bool intersects(const linePointRef& ln, point& pt) const;
|
|
|
|
//- Contains point or other bounding box?
|
|
using boundBox::contains;
|
|
|
|
//- Contains point (inside or on edge) and moving in direction
|
|
// dir would cause it to go inside.
|
|
bool contains(const vector& dir, const point&) const;
|
|
|
|
//- Code position of point on bounding box faces
|
|
direction faceBits(const point& pt) const;
|
|
|
|
//- Position of point relative to bounding box
|
|
direction posBits(const point& pt) const;
|
|
|
|
//- Calculate nearest and furthest (to point) vertex coords of
|
|
// bounding box
|
|
void calcExtremities
|
|
(
|
|
const point& pt,
|
|
point& nearest,
|
|
point& furthest
|
|
) const;
|
|
|
|
//- Returns distance point to furthest away corner.
|
|
scalar maxDist(const point& pt) const;
|
|
|
|
//- Compare distance to point with other bounding box
|
|
// return:
|
|
// -1 : all vertices of my bounding box are nearer than any of
|
|
// other
|
|
// +1 : all vertices of my bounding box are further away than
|
|
// any of other
|
|
// 0 : none of the above.
|
|
label distanceCmp(const point& pt, const treeBoundBox& other) const;
|
|
|
|
//- Return slightly wider bounding box
|
|
// Extends all dimensions with s*span*Random::sample01<scalar>()
|
|
// and guarantees in any direction s*mag(span) minimum width
|
|
inline treeBoundBox extend(Random& rndGen, const scalar s) const;
|
|
|
|
//- As per two parameter version but with additional
|
|
//- grow() by given amount in each dimension
|
|
inline treeBoundBox extend
|
|
(
|
|
Random& rndGen,
|
|
const scalar s,
|
|
const scalar delta
|
|
) const;
|
|
|
|
|
|
// IOstream Operators
|
|
|
|
friend Istream& operator>>(Istream& is, treeBoundBox& bb);
|
|
friend Ostream& operator<<(Ostream& os, const treeBoundBox& bb);
|
|
|
|
|
|
// Housekeeping
|
|
|
|
//- Typical dimension length,height,width. Identical to avgDim()
|
|
scalar typDim() const { return avgDim(); }
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * Traits * * * * * * * * * * * * * * * * //
|
|
|
|
//- Contiguous data for treeBoundBox
|
|
template<> struct is_contiguous<treeBoundBox> : is_contiguous<boundBox> {};
|
|
|
|
//- Contiguous scalar data for treeBoundBox
|
|
template<> struct is_contiguous_scalar<treeBoundBox>
|
|
:
|
|
is_contiguous_scalar<boundBox>
|
|
{};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Global Operators * * * * * * * * * * * * * //
|
|
|
|
inline bool operator==(const treeBoundBox& a, const treeBoundBox& b);
|
|
inline bool operator!=(const treeBoundBox& a, const treeBoundBox& b);
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
#include "treeBoundBoxI.H"
|
|
|
|
#ifdef NoRepository
|
|
#include "treeBoundBoxTemplates.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|