Creates the parallel distribution map by describing the source and target objects using box shapes. More...

#include <box.H>

Inheritance diagram for box:

[legend]

Collaboration diagram for box:

[legend]

Public Member Functions
	TypeName ("box")
	Runtime type information.
	box (const UList< point > &srcPoints, const UList< point > &tgtPoints, const label maxObjectsPerLeaf, const label nObjectsOfType, const label nRefineIterMax=100)
	Construct from list of points for source and target.
virtual	~box ()=default
	Destructor.
Public Member Functions inherited from processorLOD
	TypeName ("processorLOD")
	Runtime type information.
	processorLOD (const label maxObjectsPerLeaf, const label nObjectsOfType) noexcept
	Construct from components.
virtual	~processorLOD ()=default
	Destructor.
virtual autoPtr< mapDistribute >	map (const mapDistributeBase::layoutTypes constructLayout=mapDistributeBase::layoutTypes::linear)=0
	Return the parallel distribution map (usually linear construct order).

Protected Member Functions
void	writeBoxes (const List< DynamicList< treeBoundBox > > &fixedBoxes, const label iter) const
	Helper function to write the boxes in OBJ format.
virtual treeBoundBox	calcSrcBox (const label srcObji) const =0
	The local boundBox associated with given source object.
virtual treeBoundBox	calcTgtBox (const label tgtObji) const =0
	The local boundBox associated with given target object.
void	setRefineFlags (const label refineIter, const label nTgtObjects, List< labelHashSet > &fixedSendElems, List< List< labelList > > &localTgtElems, List< labelList > &refineFlags, labelList &nElems) const
	Set the box refinement flags.
void	refineBox (const label boxi, const label refineIter, const label nSrcElem, const treeBoundBox &origBox, DynamicList< treeBoundBox > &procBoxes, DynamicList< labelList > &procBoxElems, DynamicList< label > &procNewToOld) const
void	refineBox (const label boxi, const labelList &srcAddr, const treeBoundBox &origBox, DynamicList< treeBoundBox > &procBoxes, DynamicList< labelList > &procBoxElems, DynamicList< label > &procNewToOld) const
bool	doRefineBoxes (const label refineIter, const label nSrcFaces, const List< labelList > &refineFlags, List< DynamicList< treeBoundBox > > &fixedBoxes)
	Apply the box refinements.
autoPtr< mapDistribute >	createMap (const label nSrcElems, const label nTgtElems, const mapDistributeBase::layoutTypes constructLayout)
	Return the parallel distribution map (often linear construct order).

Protected Attributes
const UList< point > &	srcPoints_
	Reference to the source points.
const UList< point > &	tgtPoints_
	Reference to the target points.
List< List< treeBoundBox > >	boxes_
	Per processor, the list of src bound boxes.
label	nRefineIterMax_
	Maximum number of refinement iterations.
List< labelList >	newToOld_
	Addressing per proc of new to old bound boxes.
List< List< labelList > >	boxSrcElems_
	Indices of elements in the src boxes.
Protected Attributes inherited from processorLOD
label	maxObjectsPerLeaf_
	Maximum number of objects per leaf.
label	nObjectsOfType_
	Number of objects of this type. e.g. number of faces/cells on this processor.

Static Protected Attributes
static const label	DROP = 0
	Drop/discard.
static const label	REFINE = 1
	Refine.
static const label	FIXED = 2
	Fixed - do not touch.
static const label	nStartUpIter = 2
	Number of iterations before element indices are cached.

Detailed Description

Creates the parallel distribution map by describing the source and target objects using box shapes.

A single box is created for the source object, which is then split using 2x2x2 refinement based on the number of remote target objects that overlap. The refinement is local between communicating processor pairs, where the refinement continues until a threshold number of remote target objects per source box is achieved.

Definition at line 52 of file box.H.

Constructor & Destructor Documentation

◆ box()

box	(	const UList< point > &	srcPoints,
		const UList< point > &	tgtPoints,
		const label	maxObjectsPerLeaf,
		const label	nObjectsOfType,
		const label	nRefineIterMax = 100 )

Construct from list of points for source and target.

Definition at line 532 of file box.C.

References boxes_, boxSrcElems_, newToOld_, nRefineIterMax_, processorLOD::processorLOD(), srcPoints_, and tgtPoints_.

Referenced by faceBox::faceBox().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~box()

virtual ~box ( )

virtualdefault

Destructor.

Member Function Documentation

◆ writeBoxes()

void writeBoxes	(	const List< DynamicList< treeBoundBox > > &	fixedBoxes,
		const label	iter ) const

protected

Helper function to write the boxes in OBJ format.

Definition at line 41 of file box.C.

References UPstream::allProcs(), f(), treeBoundBox::faces, UPstream::myProcNo(), Foam::name(), Foam::nl, os(), pts, timeIndex, and Foam::meshTools::writeOBJ().

Referenced by createMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcSrcBox()

virtual treeBoundBox calcSrcBox ( const label srcObji ) const

protectedpure virtual

The local boundBox associated with given source object.

Implemented in cellBox, and faceBox.

Referenced by refineBox(), and refineBox().

Here is the caller graph for this function:

◆ calcTgtBox()

virtual treeBoundBox calcTgtBox ( const label tgtObji ) const

protectedpure virtual

The local boundBox associated with given target object.

Implemented in cellBox, and faceBox.

Referenced by setRefineFlags().

Here is the caller graph for this function:

◆ setRefineFlags()

void setRefineFlags	(	const label	refineIter,
		const label	nTgtObjects,
		List< labelHashSet > &	fixedSendElems,
		List< List< labelList > > &	localTgtElems,
		List< labelList > &	refineFlags,
		labelList &	nElems ) const

protected

Set the box refinement flags.

Definition at line 88 of file box.C.

References UPstream::allProcs(), DynamicList< T, SizeMin >::append(), boxes_, calcTgtBox(), UList< T >::empty(), PstreamBuffers::finishedSends(), FIXED, forAll, Foam::identity(), processorLOD::maxObjectsPerLeaf_, UPstream::myProcNo(), newToOld_, processorLOD::nObjectsOfType_, nStartUpIter, Foam::readLabel(), PstreamBuffers::recvDataCount(), REFINE, List< T >::setSize(), UList< T >::size(), and List< T >::transfer().

Referenced by createMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refineBox() [1/2]

void refineBox	(	const label	boxi,
		const label	refineIter,
		const label	nSrcElem,
		const treeBoundBox &	origBox,
		DynamicList< treeBoundBox > &	procBoxes,
		DynamicList< labelList > &	procBoxElems,
		DynamicList< label > &	procNewToOld ) const

protected

Definition at line 208 of file box.C.

References DynamicList< T, SizeMin >::append(), calcSrcBox(), nStartUpIter, treeBoundBox::overlaps(), UList< T >::size(), and treeBoundBox::subBbox().

Referenced by doRefineBoxes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refineBox() [2/2]

void refineBox	(	const label	boxi,
		const labelList &	srcAddr,
		const treeBoundBox &	origBox,
		DynamicList< treeBoundBox > &	procBoxes,
		DynamicList< labelList > &	procBoxElems,
		DynamicList< label > &	procNewToOld ) const

protected

Definition at line 266 of file box.C.

References DynamicList< T, SizeMin >::append(), calcSrcBox(), treeBoundBox::overlaps(), UList< T >::size(), and treeBoundBox::subBbox().

Here is the call graph for this function:

◆ doRefineBoxes()

bool doRefineBoxes	(	const label	refineIter,
		const label	nSrcFaces,
		const List< labelList > &	refineFlags,
		List< DynamicList< treeBoundBox > > &	fixedBoxes )

protected

Apply the box refinements.

Returns: true if still refining

Definition at line 303 of file box.C.

References Foam::abort(), UPstream::allProcs(), boxes_, boxSrcElems_, DROP, Foam::FatalError, FatalErrorInFunction, PstreamBuffers::finishedSends(), FIXED, forAll, UPstream::myProcNo(), newToOld_, UPstream::nProcs(), nStartUpIter, REFINE, refineBox(), Foam::returnReduceOr(), and UList< T >::size().

Referenced by createMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMap()

Foam::autoPtr< Foam::mapDistribute > createMap	(	const label	nSrcElems,
		const label	nTgtElems,
		const mapDistributeBase::layoutTypes	constructLayout )

protected

Return the parallel distribution map (often linear construct order).

Definition at line 408 of file box.C.

References List< T >::append(), boxes_, List< T >::clear(), doRefineBoxes(), Foam::endl(), forAll, Foam::identity(), HashSet< Key, Hash >::insert(), UPstream::myProcNo(), autoPtr< T >::New(), Foam::nl, UPstream::nProcs(), nRefineIterMax_, Foam::Pout, setRefineFlags(), UList< T >::size(), HashTable< T, Key, Hash >::sortedToc(), Foam::tab, writeBoxes(), and Foam::Zero.

Referenced by cellBox::map(), and faceBox::map().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "box" )

Runtime type information.

Member Data Documentation

◆ DROP

const Foam::label DROP = 0

staticprotected

Drop/discard.

Definition at line 65 of file box.H.

Referenced by doRefineBoxes().

◆ REFINE

const Foam::label REFINE = 1

staticprotected

Refine.

Definition at line 70 of file box.H.

Referenced by doRefineBoxes(), and setRefineFlags().

◆ FIXED

const Foam::label FIXED = 2

staticprotected

Fixed - do not touch.

Definition at line 75 of file box.H.

Referenced by doRefineBoxes(), and setRefineFlags().

◆ srcPoints_

const UList<point>& srcPoints_

protected

Reference to the source points.

Definition at line 81 of file box.H.

Referenced by box(), cellBox::calcSrcBox(), and faceBox::calcSrcBox().

◆ tgtPoints_

const UList<point>& tgtPoints_

protected

Reference to the target points.

Definition at line 86 of file box.H.

Referenced by box(), cellBox::calcTgtBox(), and faceBox::calcTgtBox().

◆ boxes_

List<List<treeBoundBox> > boxes_

protected

Per processor, the list of src bound boxes.

Note: using treeBoundBox to take advantage of subBbox() method

Definition at line 93 of file box.H.

Referenced by box(), createMap(), doRefineBoxes(), and setRefineFlags().

◆ nRefineIterMax_

label nRefineIterMax_

protected

Maximum number of refinement iterations.

Definition at line 98 of file box.H.

Referenced by box(), and createMap().

◆ nStartUpIter

const Foam::label nStartUpIter = 2

staticprotected

Number of iterations before element indices are cached.

Definition at line 106 of file box.H.

Referenced by doRefineBoxes(), refineBox(), and setRefineFlags().

◆ newToOld_

List<labelList> newToOld_

protected

Addressing per proc of new to old bound boxes.

Definition at line 111 of file box.H.

Referenced by box(), doRefineBoxes(), and setRefineFlags().

◆ boxSrcElems_

List<List<labelList> > boxSrcElems_

protected

Indices of elements in the src boxes.

Definition at line 116 of file box.H.

Referenced by box(), and doRefineBoxes().

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

src/meshTools/processorLOD/box/box.H
src/meshTools/processorLOD/box/box.C

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ box()

◆ ~box()

Member Function Documentation

◆ writeBoxes()

◆ calcSrcBox()

◆ calcTgtBox()

◆ setRefineFlags()

◆ refineBox() [1/2]

◆ refineBox() [2/2]

◆ doRefineBoxes()

◆ createMap()

◆ TypeName()

Member Data Documentation

◆ DROP

◆ REFINE

◆ FIXED

◆ srcPoints_

◆ tgtPoints_

◆ boxes_

◆ nRefineIterMax_

◆ nStartUpIter

◆ newToOld_

◆ boxSrcElems_