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

#include <faceBox.H>

Inheritance diagram for faceBox:

[legend]

Collaboration diagram for faceBox:

[legend]

Public Member Functions
	TypeName ("box")
	Runtime type information.
	faceBox (const faceList &srcFaces, const UList< point > &srcPoints, const faceList &tgtFaces, const UList< point > &tgtPoints, const label maxObjectsPerLeaf, const label nObjectsOfType, const label nRefineIterMax=100)
	Construct from list of points/faces for source and target.
virtual	~faceBox ()=default
	Destructor.
virtual autoPtr< mapDistribute >	map (const mapDistributeBase::layoutTypes constructLayout)
	Return the parallel distribution map (usually linear construct order).
Public Member Functions inherited from box
	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.

Protected Member Functions
virtual treeBoundBox	calcSrcBox (const label srcObji) const
	The local boundBox associated with given source object.
virtual treeBoundBox	calcTgtBox (const label tgtObji) const
	The local boundBox associated with given target object.
Protected Member Functions inherited from box
void	writeBoxes (const List< DynamicList< treeBoundBox > > &fixedBoxes, const label iter) const
	Helper function to write the boxes in OBJ format.
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 faceList &	srcFaces_
	Reference to the source face list.
const faceList &	tgtFaces_
	Reference to the target face list.
Protected Attributes inherited from box
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.

Additional Inherited Members
Static Protected Attributes inherited from box
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 50 of file faceBox.H.

Constructor & Destructor Documentation

◆ faceBox()

faceBox	(	const faceList &	srcFaces,
		const UList< point > &	srcPoints,
		const faceList &	tgtFaces,
		const UList< point > &	tgtPoints,
		const label	maxObjectsPerLeaf,
		const label	nObjectsOfType,
		const label	nRefineIterMax = 100 )

Construct from list of points/faces for source and target.

Definition at line 54 of file faceBox.C.

References box::box(), srcFaces_, and tgtFaces_.

Referenced by cellBox::cellBox().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~faceBox()

virtual ~faceBox ( )

virtualdefault

Destructor.

Member Function Documentation

◆ calcSrcBox()

Foam::treeBoundBox calcSrcBox ( const label srcObji ) const

protectedvirtual

The local boundBox associated with given source object.

Implements box.

Reimplemented in cellBox.

Definition at line 34 of file faceBox.C.

References srcFaces_, and box::srcPoints_.

◆ calcTgtBox()

Foam::treeBoundBox calcTgtBox ( const label tgtObji ) const

protectedvirtual

The local boundBox associated with given target object.

Implements box.

Reimplemented in cellBox.

Definition at line 43 of file faceBox.C.

References tgtFaces_, and box::tgtPoints_.

◆ TypeName()

TypeName ( "box" )

Runtime type information.

◆ map()

Foam::autoPtr< Foam::mapDistribute > map ( const mapDistributeBase::layoutTypes constructLayout )

virtual

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

Implements processorLOD.

Reimplemented in cellBox.

Definition at line 74 of file faceBox.C.

References box::createMap(), srcFaces_, and tgtFaces_.

Here is the call graph for this function:

Member Data Documentation

◆ srcFaces_

const faceList& srcFaces_

protected

Reference to the source face list.

Definition at line 61 of file faceBox.H.

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

◆ tgtFaces_

const faceList& tgtFaces_

protected

Reference to the target face list.

Definition at line 66 of file faceBox.H.

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

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

src/meshTools/processorLOD/faceBox/faceBox.H
src/meshTools/processorLOD/faceBox/faceBox.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ faceBox()

◆ ~faceBox()

Member Function Documentation

◆ calcSrcBox()

◆ calcTgtBox()

◆ TypeName()

◆ map()

Member Data Documentation

◆ srcFaces_

◆ tgtFaces_