Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
boundBox Class Reference

A bounding box defined in terms of the points at its extremities. More...

Inheritance diagram for boundBox:
Inheritance graph
[legend]
Collaboration diagram for boundBox:
Collaboration graph
[legend]

Public Member Functions

 boundBox ()
 Construct null, setting points to zero. More...
 
 boundBox (const point &min, const point &max)
 Construct from components. More...
 
 boundBox (const UList< point > &, const bool doReduce=true)
 Construct as the bounding box of the given points. More...
 
 boundBox (const tmp< pointField > &, const bool doReduce=true)
 Construct as the bounding box of the given temporary pointField. More...
 
 boundBox (const UList< point > &, const labelUList &indices, const bool doReduce=true)
 Construct bounding box as subset of the pointField. More...
 
template<unsigned Size>
 boundBox (const UList< point > &, const FixedList< label, Size > &indices, const bool doReduce=true)
 Construct bounding box as subset of the pointField. More...
 
 boundBox (Istream &)
 Construct from Istream. More...
 
const pointmin () const
 Minimum describing the bounding box. More...
 
const pointmax () const
 Maximum describing the bounding box. More...
 
pointmin ()
 Minimum describing the bounding box, non-const access. More...
 
pointmax ()
 Maximum describing the bounding box, non-const access. More...
 
point midpoint () const
 The midpoint of the bounding box. More...
 
vector span () const
 The bounding box span (from minimum to maximum) More...
 
scalar mag () const
 The magnitude of the bounding box span. More...
 
scalar volume () const
 The volume of the bound box. More...
 
scalar minDim () const
 Smallest length/height/width dimension. More...
 
scalar maxDim () const
 Largest length/height/width dimension. More...
 
scalar avgDim () const
 Average length/height/width dimension. More...
 
tmp< pointFieldpoints () const
 Return corner points in an order corresponding to a 'hex' cell. More...
 
void inflate (const scalar s)
 Inflate box by factor*mag(span) in all dimensions. More...
 
bool overlaps (const boundBox &) const
 Overlaps/touches boundingBox? More...
 
bool overlaps (const point &, const scalar radiusSqr) const
 Overlaps boundingSphere (centre + sqr(radius))? More...
 
bool contains (const point &) const
 Contains point? (inside or on edge) More...
 
bool contains (const boundBox &) const
 Fully contains other boundingBox? More...
 
bool containsInside (const point &) const
 Contains point? (inside only) More...
 
bool contains (const UList< point > &) const
 Contains all of the points? (inside or on edge) More...
 
bool contains (const UList< point > &, const labelUList &indices) const
 Contains all of the points? (inside or on edge) More...
 
template<unsigned Size>
bool contains (const UList< point > &, const FixedList< label, Size > &indices) const
 Contains all of the points? (inside or on edge) More...
 
bool containsAny (const UList< point > &) const
 Contains any of the points? (inside or on edge) More...
 
bool containsAny (const UList< point > &, const labelUList &indices) const
 Contains any of the points? (inside or on edge) More...
 
template<unsigned Size>
bool containsAny (const UList< point > &, const FixedList< label, Size > &indices) const
 Contains any of the points? (inside or on edge) More...
 
point nearest (const point &) const
 Return the nearest point on the boundBox to the supplied point. More...
 

Static Public Member Functions

static faceList faces ()
 Return faces with correct point order. More...
 

Static Public Attributes

static const scalar great
 The great value used for greatBox and invertedBox. More...
 
static const boundBox greatBox
 A very large boundBox: min/max == -/+ VGREAT. More...
 
static const boundBox invertedBox
 A very large inverted boundBox: min/max == +/- VGREAT. More...
 

Friends

bool operator== (const boundBox &, const boundBox &)
 
bool operator!= (const boundBox &, const boundBox &)
 
Istreamoperator>> (Istream &, boundBox &)
 
Ostreamoperator<< (Ostream &, const boundBox &)
 

Detailed Description

A bounding box defined in terms of the points at its extremities.

Definition at line 55 of file boundBox.H.

Constructor & Destructor Documentation

boundBox ( )
inline

Construct null, setting points to zero.

Definition at line 32 of file boundBoxI.H.

Referenced by boundBox::boundBox().

Here is the caller graph for this function:

boundBox ( const point min,
const point max 
)
inline

Construct from components.

Definition at line 39 of file boundBoxI.H.

boundBox ( const UList< point > &  points,
const bool  doReduce = true 
)

Construct as the bounding box of the given points.

Does parallel communication (doReduce = true)

Definition at line 88 of file boundBox.C.

boundBox ( const tmp< pointField > &  points,
const bool  doReduce = true 
)

Construct as the bounding box of the given temporary pointField.

Does parallel communication (doReduce = true)

Definition at line 97 of file boundBox.C.

References boundBox::boundBox(), tmp< T >::clear(), and boundBox::points().

Here is the call graph for this function:

boundBox ( const UList< point > &  points,
const labelUList indices,
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)

Definition at line 108 of file boundBox.C.

References UList< T >::empty(), Foam::max(), Foam::min(), UPstream::parRun(), and Foam::reduce().

Here is the call graph for this function:

boundBox ( const UList< point > &  points,
const FixedList< label, Size > &  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)

Definition at line 35 of file boundBoxTemplates.C.

References boundBox::contains(), UList< T >::empty(), Foam::max(), Foam::min(), and Foam::reduce().

Here is the call graph for this function:

boundBox ( Istream is)
inline

Construct from Istream.

Definition at line 46 of file boundBoxI.H.

References boundBox::operator>>.

Member Function Documentation

const Foam::point & min ( ) const
inline
const Foam::point & max ( ) const
inline
Foam::point & min ( )
inline

Minimum describing the bounding box, non-const access.

Definition at line 66 of file boundBoxI.H.

Foam::point & max ( )
inline

Maximum describing the bounding box, non-const access.

Definition at line 72 of file boundBoxI.H.

Foam::point midpoint ( ) const
inline

The midpoint of the bounding box.

Definition at line 78 of file boundBoxI.H.

Referenced by dynamicIndexedOctree< Type >::overlaps(), indexedOctree< Type >::overlaps(), treeBoundBox::searchOrder(), treeBoundBox::subBbox(), and treeBoundBox::subOctant().

Here is the caller graph for this function:

Foam::vector span ( ) const
inline
Foam::scalar mag ( ) const
inline

The magnitude of the bounding box span.

Definition at line 90 of file boundBoxI.H.

References Foam::mag().

Referenced by nearWallFields::calcAddressing(), searchableSurfaces::checkSizes(), patchProbes::findElements(), globalMeshData::geometricSharedPoints(), boundBox::inflate(), isoSurfaceCell::isoSurfaceCell(), wallBoundedStreamLineParticle::move(), and globalMeshData::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar volume ( ) const
inline

The volume of the bound box.

Definition at line 96 of file boundBoxI.H.

References Foam::cmptProduct(), and boundBox::span().

Here is the call graph for this function:

Foam::scalar minDim ( ) const
inline

Smallest length/height/width dimension.

Definition at line 102 of file boundBoxI.H.

References Foam::cmptMin(), and boundBox::span().

Here is the call graph for this function:

Foam::scalar maxDim ( ) const
inline

Largest length/height/width dimension.

Definition at line 108 of file boundBoxI.H.

References Foam::cmptMax(), and boundBox::span().

Here is the call graph for this function:

Foam::scalar avgDim ( ) const
inline

Average length/height/width dimension.

Definition at line 114 of file boundBoxI.H.

References Foam::cmptAv(), and boundBox::span().

Referenced by boundaryMesh::getNearest(), and treeBoundBox::typDim().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::tmp< Foam::pointField > points ( ) const

Return corner points in an order corresponding to a 'hex' cell.

Definition at line 149 of file boundBox.C.

References Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by boundBox::boundBox().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::faceList faces ( )
static

Return faces with correct point order.

Definition at line 167 of file boundBox.C.

References forAll, and List< T >::setSize().

Referenced by searchableBox::boundingSpheres(), and searchableBox::coordinates().

Here is the call graph for this function:

Here is the caller graph for this function:

void inflate ( const scalar  s)

Inflate box by factor*mag(span) in all dimensions.

Definition at line 210 of file boundBox.C.

References boundBox::mag(), and Vector< Cmpt >::one.

Referenced by meshToMeshMethod::maskCells(), NamedEnum< Enum, nEnum >::names(), surfaceFeatures::nearestSurfEdge(), and AMIMethod< SourcePatch, TargetPatch >::resetTree().

Here is the call graph for this function:

Here is the caller graph for this function:

bool overlaps ( const boundBox bb) const
inline
bool overlaps ( const point centre,
const scalar  radiusSqr 
) const
inline

Overlaps boundingSphere (centre + sqr(radius))?

Definition at line 132 of file boundBoxI.H.

References Foam::mag(), and VectorSpace< Vector< Cmpt >, Cmpt, 3 >::nComponents.

Here is the call graph for this function:

bool contains ( const point pt) const
inline

Contains point? (inside or on edge)

Definition at line 170 of file boundBoxI.H.

References Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by boundBox::boundBox(), boundBox::contains(), boundBox::containsAny(), and primitiveMesh::pointInCellBB().

Here is the call graph for this function:

Here is the caller graph for this function:

bool contains ( const boundBox bb) const
inline

Fully contains other boundingBox?

Definition at line 182 of file boundBoxI.H.

References boundBox::contains(), boundBox::max(), and boundBox::min().

Here is the call graph for this function:

bool containsInside ( const point pt) const
inline

Contains point? (inside only)

Definition at line 188 of file boundBoxI.H.

References Foam::constant::physicoChemical::b, Foam::operator!=(), Foam::operator==(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

bool contains ( const UList< point > &  points) const

Contains all of the points? (inside or on edge)

Definition at line 219 of file boundBox.C.

References boundBox::contains(), UList< T >::empty(), and forAll.

Here is the call graph for this function:

bool contains ( const UList< point > &  points,
const labelUList indices 
) const

Contains all of the points? (inside or on edge)

Definition at line 239 of file boundBox.C.

References boundBox::contains(), UList< T >::empty(), and forAll.

Here is the call graph for this function:

bool contains ( const UList< point > &  points,
const FixedList< label, Size > &  indices 
) const

Contains all of the points? (inside or on edge)

Definition at line 79 of file boundBoxTemplates.C.

References boundBox::containsAny(), UList< T >::empty(), and forAll.

Here is the call graph for this function:

bool containsAny ( const UList< point > &  points) const

Contains any of the points? (inside or on edge)

Definition at line 261 of file boundBox.C.

References boundBox::contains(), UList< T >::empty(), and forAll.

Referenced by boundBox::contains(), treeDataFace::overlaps(), and treeDataPrimitivePatch< PatchType >::overlaps().

Here is the call graph for this function:

Here is the caller graph for this function:

bool containsAny ( const UList< point > &  points,
const labelUList indices 
) const

Contains any of the points? (inside or on edge)

Definition at line 281 of file boundBox.C.

References boundBox::contains(), UList< T >::empty(), and forAll.

Here is the call graph for this function:

bool containsAny ( const UList< point > &  points,
const FixedList< label, Size > &  indices 
) const

Contains any of the points? (inside or on edge)

Definition at line 104 of file boundBoxTemplates.C.

References UList< T >::empty(), and forAll.

Here is the call graph for this function:

Foam::point nearest ( const point pt) const

Return the nearest point on the boundBox to the supplied point.

If point is inside the boundBox then the point is returned unchanged.

Definition at line 303 of file boundBox.C.

References Foam::max(), Foam::min(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

Friends And Related Function Documentation

bool operator== ( const boundBox ,
const boundBox  
)
friend
bool operator!= ( const boundBox ,
const boundBox  
)
friend
Istream& operator>> ( Istream ,
boundBox  
)
friend

Referenced by boundBox::boundBox().

Ostream& operator<< ( Ostream ,
const boundBox  
)
friend

Member Data Documentation

const Foam::scalar great
static

The great value used for greatBox and invertedBox.

Definition at line 73 of file boundBox.H.

const Foam::boundBox greatBox
static

A very large boundBox: min/max == -/+ VGREAT.

Definition at line 76 of file boundBox.H.

const Foam::boundBox invertedBox
static

A very large inverted boundBox: min/max == +/- VGREAT.

Definition at line 79 of file boundBox.H.

Referenced by NamedEnum< Enum, nEnum >::names(), and triSurface::writeStats().


The documentation for this class was generated from the following files: