Wave propagation of information through grid. Every iteration information goes through one layer of cells. Templated on information that is transferred. More...

Inheritance diagram for FaceCellWave< Type, TrackingData >:

[legend]

Collaboration diagram for FaceCellWave< Type, TrackingData >:

[legend]

Public Member Functions
	FaceCellWave (const polyMesh &mesh, UList< Type > &allFaceInfo, UList< Type > &allCellInfo, TrackingData &td=dummyTrackData_)

	FaceCellWave (const polyMesh &mesh, const labelUList &initialChangedFaces, const List< Type > &changedFacesInfo, UList< Type > &allFaceInfo, UList< Type > &allCellInfo, const label maxIter, TrackingData &td=dummyTrackData_)
	Construct from mesh and list of changed faces with the Type. More...

	FaceCellWave (const polyMesh &mesh, const labelPairList &explicitConnections, const bool handleCyclicAMI, const labelUList &initialChangedFaces, const List< Type > &changedFacesInfo, UList< Type > &allFaceInfo, UList< Type > &allCellInfo, const label maxIter, TrackingData &td=dummyTrackData_)
	Construct from mesh and explicitly connected boundary faces. More...

virtual	~FaceCellWave ()=default
	Destructor. More...

UList< Type > &	allFaceInfo ()
	Access allFaceInfo. More...

UList< Type > &	allCellInfo ()
	Access allCellInfo. More...

const TrackingData &	data () const
	Additional data to be passed into container. More...

const polyMesh &	mesh () const
	Access mesh. More...

label	nUnvisitedCells () const

label	nUnvisitedFaces () const
	Get number of unvisited faces. More...

void	setFaceInfo (const label facei, const Type &faceInfo)
	Set single initial changed face. More...

void	setFaceInfo (const labelUList &changedFaces, const List< Type > &changedFacesInfo)
	Set initial changed faces. More...

virtual label	faceToCell ()
	Propagate from face to cell. More...

virtual label	cellToFace ()
	Propagate from cell to face. More...

virtual label	iterate (const label maxIter)
	Iterate until no changes or maxIter reached. More...

Static Public Member Functions
static scalar	propagationTol ()
	Access to tolerance. More...

static void	setPropagationTol (const scalar tol)
	Change tolerance. More...

Protected Types
typedef std::pair< label, Type >	taggedInfoType
	Information tagged with a source or destination id. More...

Protected Member Functions
bool	updateCell (const label celli, const label neighbourFacei, const Type &neighbourInfo, const scalar tol, Type &cellInfo)
	Updates cellInfo with information from neighbour. More...

bool	updateFace (const label facei, const label neighbourCelli, const Type &neighbourInfo, const scalar tol, Type &faceInfo)
	Updates faceInfo with information from neighbour. More...

bool	updateFace (const label facei, const Type &neighbourInfo, const scalar tol, Type &faceInfo)
	Updates faceInfo with information from same face. More...

void	checkCyclic (const polyPatch &pPatch) const
	Debugging: check info on both sides of cyclic. More...

template<class PatchType >
bool	hasPatch () const
	Has cyclic patch? More...

void	mergeFaceInfo (const polyPatch &patch, const label nFaces, const labelUList &changedFaces, const List< Type > &changedFacesInfo)
	Merge received patch data into global data. More...

label	getChangedPatchFaces (const polyPatch &patch, const label startFacei, const label nFaces, labelList &changedPatchFaces, List< Type > &changedPatchFacesInfo) const
	Extract info for single patch only. More...

void	leaveDomain (const polyPatch &patch, const label nFaces, const labelUList &faceLabels, List< Type > &faceInfo) const
	Handle leaving domain. Implementation referred to Type. More...

void	enterDomain (const polyPatch &patch, const label nFaces, const labelUList &faceLabels, List< Type > &faceInfo) const
	Handle leaving domain. Implementation referred to Type. More...

void	transform (const tensorField &rotTensor, const label nFaces, List< Type > &faceInfo)
	Apply transformation to Type. More...

void	handleProcPatches ()
	Merge data from across processor boundaries. More...

void	handleCyclicPatches ()
	Merge data from across cyclics. More...

void	handleAMICyclicPatches ()
	Merge data from across AMI cyclics. More...

void	handleExplicitConnections ()
	Merge data across explicitly provided local connections. More...

	FaceCellWave (const FaceCellWave &)=delete
	No copy construct. More...

void	operator= (const FaceCellWave &)=delete
	No copy assignment. More...

Static Protected Member Functions
static void	offset (const polyPatch &patch, const label off, const label nFaces, labelList &faces)
	Offset face labels by constant value. More...

Protected Attributes
const polyMesh &	mesh_
	Reference to mesh. More...

const labelPairList	explicitConnections_
	Optional boundary faces that information should travel through. More...

UList< Type > &	allFaceInfo_
	Information for all faces. More...

UList< Type > &	allCellInfo_
	Information for all cells. More...

TrackingData &	td_
	Additional data to be passed into container. More...

bitSet	changedFace_
	Has face changed. More...

bitSet	changedCell_
	Has cell changed. More...

DynamicList< label >	changedFaces_
	List of changed faces. More...

DynamicList< label >	changedCells_

DynamicList< taggedInfoType >	changedBaffles_

const bool	hasCyclicPatches_
	Contains cyclics. More...

const bool	hasCyclicAMIPatches_
	Contains cyclicAMI. More...

label	nEvals_
	Number of evaluations. More...

label	nUnvisitedCells_
	Number of unvisited cells/faces. More...

label	nUnvisitedFaces_

Static Protected Attributes
static const scalar	geomTol_ = 1e-6

static scalar	propagationTol_ = 0.01

static int	dummyTrackData_ = 12345
	Default trackdata value to satisfy default template argument. More...

Detailed Description

template<class Type, class TrackingData = int>
class Foam::FaceCellWave< Type, TrackingData >

Wave propagation of information through grid. Every iteration information goes through one layer of cells. Templated on information that is transferred.

Handles parallel and cyclics and non-parallel cyclics.

Note: whether to propagate depends on the return value of Type::update which returns true (i.e. propagate) if the value changes by more than a certain tolerance. This tolerance can be very strict for normal face-cell and parallel cyclics (we use a value of 0.01 just to limit propagation of small changes) but for non-parallel cyclics this tolerance can be critical and if chosen too small can lead to non-convergence.

Source files

Definition at line 78 of file FaceCellWave.H.

Member Typedef Documentation

◆ taggedInfoType

typedef std::pair<label,Type> taggedInfoType

protected

Information tagged with a source or destination id.

With std::pair as lightweight, movable container.

Definition at line 86 of file FaceCellWave.H.

Constructor & Destructor Documentation

◆ FaceCellWave() [1/4]

FaceCellWave ( const FaceCellWave< Type, TrackingData > & )

protecteddelete

No copy construct.

◆ FaceCellWave() [2/4]

FaceCellWave	(	const polyMesh &	mesh,
		UList< Type > &	allFaceInfo,
		UList< Type > &	allCellInfo,
		TrackingData &	td = `dummyTrackData_`
	)

Construct from mesh. Use setFaceInfo and iterate() to do actual calculation.

Definition at line 883 of file FaceCellWave.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and UList< T >::size().

Here is the call graph for this function:

◆ FaceCellWave() [3/4]

FaceCellWave	(	const polyMesh &	mesh,
		const labelUList &	initialChangedFaces,
		const List< Type > &	changedFacesInfo,
		UList< Type > &	allFaceInfo,
		UList< Type > &	allCellInfo,
		const label	maxIter,
		TrackingData &	td = `dummyTrackData_`
	)

Construct from mesh and list of changed faces with the Type.

for these faces. Iterates until nothing changes or maxIter reached. (maxIter can be 0 or negative). 0 initializes, -1 does not

Definition at line 928 of file FaceCellWave.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and UList< T >::size().

Here is the call graph for this function:

◆ FaceCellWave() [4/4]

FaceCellWave	(	const polyMesh &	mesh,
		const labelPairList &	explicitConnections,
		const bool	handleCyclicAMI,
		const labelUList &	initialChangedFaces,
		const List< Type > &	changedFacesInfo,
		UList< Type > &	allFaceInfo,
		UList< Type > &	allCellInfo,
		const label	maxIter,
		TrackingData &	td = `dummyTrackData_`
	)

Construct from mesh and explicitly connected boundary faces.

and list of changed faces with the Type for these faces. Iterates until nothing changes or maxIter reached. (maxIter can be 0 or negative). 0 initializes, -1 does not

Definition at line 992 of file FaceCellWave.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and UList< T >::size().

Here is the call graph for this function:

◆ ~FaceCellWave()

virtual ~FaceCellWave ( )

virtualdefault

Destructor.

Member Function Documentation

◆ updateCell()

bool updateCell	(	const label	celli,
		const label	neighbourFacei,
		const Type &	neighbourInfo,
		const scalar	tol,
		Type &	cellInfo
	)

protected

Updates cellInfo with information from neighbour.

Updates all statistics.

Definition at line 115 of file FaceCellWave.C.

References cellInfo::updateCell(), and cellInfo::valid().

Here is the call graph for this function:

◆ updateFace() [1/2]

bool updateFace	(	const label	facei,
		const label	neighbourCelli,
		const Type &	neighbourInfo,
		const scalar	tol,
		Type &	faceInfo
	)

protected

Updates faceInfo with information from neighbour.

Updates all statistics.

Definition at line 163 of file FaceCellWave.C.

◆ updateFace() [2/2]

bool updateFace	(	const label	facei,
		const Type &	neighbourInfo,
		const scalar	tol,
		Type &	faceInfo
	)

protected

Updates faceInfo with information from same face.

Updates all statistics.

Definition at line 211 of file FaceCellWave.C.

◆ checkCyclic()

void checkCyclic ( const polyPatch & pPatch ) const

protected

Debugging: check info on both sides of cyclic.

Definition at line 257 of file FaceCellWave.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, cyclicPolyPatch::neighbPatch(), Foam::foamVersion::patch, and polyPatch::start().

Here is the call graph for this function:

◆ hasPatch()

bool hasPatch ( ) const

protected

Has cyclic patch?

Definition at line 303 of file FaceCellWave.C.

References p.

◆ mergeFaceInfo()

void mergeFaceInfo	(	const polyPatch &	patch,
		const label	nFaces,
		const labelUList &	changedFaces,
		const List< Type > &	changedFacesInfo
	)

protected

Merge received patch data into global data.

Definition at line 371 of file FaceCellWave.C.

References Foam::foamVersion::patch.

◆ getChangedPatchFaces()

Foam::label getChangedPatchFaces	(	const polyPatch &	patch,
		const label	startFacei,
		const label	nFaces,
		labelList &	changedPatchFaces,
		List< Type > &	changedPatchFacesInfo
	)		const

protected

Extract info for single patch only.

Definition at line 405 of file FaceCellWave.C.

References Foam::foamVersion::patch.

◆ leaveDomain()

void leaveDomain	(	const polyPatch &	patch,
		const label	nFaces,
		const labelUList &	faceLabels,
		List< Type > &	faceInfo
	)		const

protected

Handle leaving domain. Implementation referred to Type.

Definition at line 437 of file FaceCellWave.C.

References Foam::foamVersion::patch.

◆ enterDomain()

void enterDomain	(	const polyPatch &	patch,
		const label	nFaces,
		const labelUList &	faceLabels,
		List< Type > &	faceInfo
	)		const

protected

Handle leaving domain. Implementation referred to Type.

Definition at line 460 of file FaceCellWave.C.

References Foam::foamVersion::patch.

◆ offset()

void offset	(	const polyPatch &	patch,
		const label	off,
		const label	nFaces,
		labelList &	faces
	)

staticprotected

Offset face labels by constant value.

Definition at line 512 of file FaceCellWave.C.

◆ transform()

void transform	(	const tensorField &	rotTensor,
		const label	nFaces,
		List< Type > &	faceInfo
	)

protected

Apply transformation to Type.

Definition at line 483 of file FaceCellWave.C.

References T.

◆ handleProcPatches()

void handleProcPatches ( )

protected

Merge data from across processor boundaries.

Transfer changed faces from neighbouring processors.

Definition at line 530 of file FaceCellWave.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), PstreamBuffers::finishedSends(), coupledPolyPatch::forwardT(), patchIdentifier::name(), processorPolyPatch::neighbProcNo(), coupledPolyPatch::parallel(), Foam::Pout, globalMeshData::processorPatches(), and Foam::transform().

Here is the call graph for this function:

◆ handleCyclicPatches()

void handleCyclicPatches ( )

protected

Merge data from across cyclics.

Transfer changed faces across cyclic halves

Definition at line 646 of file FaceCellWave.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), OSstream::name(), cyclicPolyPatch::neighbPatch(), Foam::foamVersion::patch, Foam::Pout, and Foam::transform().

Here is the call graph for this function:

◆ handleAMICyclicPatches()

void handleAMICyclicPatches ( )

protected

Merge data from across AMI cyclics.

Definition at line 730 of file FaceCellWave.C.

References forAll, cyclicAMIPolyPatch::neighbPatch(), Foam::foamVersion::patch, and Foam::transform().

Here is the call graph for this function:

◆ handleExplicitConnections()

void handleExplicitConnections ( )

protected

Merge data across explicitly provided local connections.

These are usually baffles

Definition at line 830 of file FaceCellWave.C.

◆ operator=()

void operator= ( const FaceCellWave< Type, TrackingData > & )

protecteddelete

No copy assignment.

◆ propagationTol()

static scalar propagationTol ( )

inlinestatic

Access to tolerance.

Definition at line 271 of file FaceCellWave.H.

References FaceCellWave< Type, TrackingData >::propagationTol_.

Referenced by combine< Type, TrackingData >::operator()().

Here is the caller graph for this function:

◆ setPropagationTol()

static void setPropagationTol ( const scalar tol )

inlinestatic

Change tolerance.

Definition at line 277 of file FaceCellWave.H.

References FaceCellWave< Type, TrackingData >::propagationTol_.

◆ allFaceInfo()

UList<Type>& allFaceInfo ( )

inline

Access allFaceInfo.

Definition at line 336 of file FaceCellWave.H.

References FaceCellWave< Type, TrackingData >::allFaceInfo_.

◆ allCellInfo()

UList<Type>& allCellInfo ( )

inline

Access allCellInfo.

Definition at line 342 of file FaceCellWave.H.

References FaceCellWave< Type, TrackingData >::allCellInfo_.

◆ data()

const TrackingData& data ( ) const

inline

Additional data to be passed into container.

Definition at line 348 of file FaceCellWave.H.

References FaceCellWave< Type, TrackingData >::td_.

Referenced by MeshWave< Type, TrackingData >::data(), structuredDecomp::decompose(), and combine< Type, TrackingData >::operator()().

Here is the caller graph for this function:

◆ mesh()

const polyMesh& mesh ( ) const

inline

Access mesh.

Definition at line 354 of file FaceCellWave.H.

References FaceCellWave< Type, TrackingData >::mesh_.

Referenced by combine< Type, TrackingData >::operator()().

Here is the caller graph for this function:

◆ nUnvisitedCells()

Foam::label nUnvisitedCells ( ) const

Get number of unvisited cells, i.e. cells that were not (yet) reached from walking across mesh.

This can happen from

not enough iterations done
a disconnected mesh
a mesh without walls in it

Definition at line 1060 of file FaceCellWave.C.

◆ nUnvisitedFaces()

Foam::label nUnvisitedFaces ( ) const

Get number of unvisited faces.

Definition at line 1067 of file FaceCellWave.C.

Referenced by MeshWave< Type, TrackingData >::nUnvisitedFaces().

Here is the caller graph for this function:

◆ setFaceInfo() [1/2]

void setFaceInfo	(	const label	facei,
		const Type &	faceInfo
	)

Set single initial changed face.

This is a noop if the face had already been visited

Definition at line 318 of file FaceCellWave.C.

Referenced by hexRef8::consistentSlowRefinement().

Here is the caller graph for this function:

◆ setFaceInfo() [2/2]

void setFaceInfo	(	const labelUList &	changedFaces,
		const List< Type > &	changedFacesInfo
	)

Set initial changed faces.

Definition at line 342 of file FaceCellWave.C.

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

Here is the call graph for this function:

◆ faceToCell()

Foam::label faceToCell ( )

virtual

Propagate from face to cell.

Returns: total number of cells (over all processors) changed.

Reimplemented in OppositeFaceCellWave< Type, TrackingData >.

Definition at line 1074 of file FaceCellWave.C.

References Foam::abort(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::Pout, and Foam::returnReduce().

Here is the call graph for this function:

◆ cellToFace()

Foam::label cellToFace ( )

virtual

Propagate from cell to face.

Returns: total number of faces (over all processors) changed. Note that faces on processor patches are counted twice.

Reimplemented in OppositeFaceCellWave< Type, TrackingData >.

Definition at line 1151 of file FaceCellWave.C.

References Foam::abort(), cells, Foam::expressions::patchExpr::debug, Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::Pout, and Foam::returnReduce().

Here is the call graph for this function:

◆ iterate()

Foam::label iterate ( const label maxIter )

virtual

Iterate until no changes or maxIter reached.

Returns: the number of iterations taken.

Definition at line 1227 of file FaceCellWave.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Info, and Foam::nl.

Referenced by hexRef8::consistentSlowRefinement().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ geomTol_

const Foam::scalar geomTol_ = 1e-6

staticprotected

Definition at line 91 of file FaceCellWave.H.

◆ propagationTol_

Foam::scalar propagationTol_ = 0.01

staticprotected

Definition at line 92 of file FaceCellWave.H.

Referenced by FaceCellWave< Type, TrackingData >::propagationTol(), and FaceCellWave< Type, TrackingData >::setPropagationTol().

◆ dummyTrackData_

int dummyTrackData_ = 12345

staticprotected

Default trackdata value to satisfy default template argument.

Definition at line 95 of file FaceCellWave.H.

◆ mesh_

const polyMesh& mesh_

protected

Reference to mesh.

Definition at line 101 of file FaceCellWave.H.

Referenced by FaceCellWave< Type, TrackingData >::mesh().

◆ explicitConnections_

const labelPairList explicitConnections_

protected

Optional boundary faces that information should travel through.

Definition at line 104 of file FaceCellWave.H.

◆ allFaceInfo_

UList<Type>& allFaceInfo_

protected

Information for all faces.

Definition at line 107 of file FaceCellWave.H.

Referenced by FaceCellWave< Type, TrackingData >::allFaceInfo().

◆ allCellInfo_

UList<Type>& allCellInfo_

protected

Information for all cells.

Definition at line 110 of file FaceCellWave.H.

Referenced by FaceCellWave< Type, TrackingData >::allCellInfo().

◆ td_

TrackingData& td_

protected

Additional data to be passed into container.

Definition at line 113 of file FaceCellWave.H.

Referenced by FaceCellWave< Type, TrackingData >::data().

◆ changedFace_

bitSet changedFace_

protected

Has face changed.

Definition at line 116 of file FaceCellWave.H.

◆ changedCell_

bitSet changedCell_

protected

Has cell changed.

Definition at line 119 of file FaceCellWave.H.

◆ changedFaces_

DynamicList<label> changedFaces_

protected

List of changed faces.

Definition at line 122 of file FaceCellWave.H.

◆ changedCells_

DynamicList<label> changedCells_

protected

Definition at line 125 of file FaceCellWave.H.

◆ changedBaffles_

DynamicList<taggedInfoType> changedBaffles_

protected

Definition at line 129 of file FaceCellWave.H.

◆ hasCyclicPatches_

const bool hasCyclicPatches_

protected

Contains cyclics.

Definition at line 132 of file FaceCellWave.H.

◆ hasCyclicAMIPatches_

const bool hasCyclicAMIPatches_

protected

Contains cyclicAMI.

Definition at line 135 of file FaceCellWave.H.

◆ nEvals_

label nEvals_

protected

Number of evaluations.

Definition at line 138 of file FaceCellWave.H.

◆ nUnvisitedCells_

label nUnvisitedCells_

protected

Number of unvisited cells/faces.

Definition at line 141 of file FaceCellWave.H.

◆ nUnvisitedFaces_

label nUnvisitedFaces_

protected

Definition at line 142 of file FaceCellWave.H.

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

src/meshTools/algorithms/MeshWave/FaceCellWave.H
src/meshTools/algorithms/MeshWave/FaceCellWave.C

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

template<class Type, class TrackingData = int> class Foam::FaceCellWave< Type, TrackingData >

Member Typedef Documentation

◆ taggedInfoType

Constructor & Destructor Documentation

◆ FaceCellWave() [1/4]

◆ FaceCellWave() [2/4]

◆ FaceCellWave() [3/4]

◆ FaceCellWave() [4/4]

◆ ~FaceCellWave()

Member Function Documentation

◆ updateCell()

◆ updateFace() [1/2]

◆ updateFace() [2/2]

◆ checkCyclic()

◆ hasPatch()

◆ mergeFaceInfo()

◆ getChangedPatchFaces()

◆ leaveDomain()

◆ enterDomain()

◆ offset()

◆ transform()

◆ handleProcPatches()

◆ handleCyclicPatches()

◆ handleAMICyclicPatches()

◆ handleExplicitConnections()

◆ operator=()

◆ propagationTol()

◆ setPropagationTol()

◆ allFaceInfo()

◆ allCellInfo()

◆ data()

◆ mesh()

◆ nUnvisitedCells()

◆ nUnvisitedFaces()

◆ setFaceInfo() [1/2]

◆ setFaceInfo() [2/2]

◆ faceToCell()

◆ cellToFace()

◆ iterate()

Member Data Documentation

◆ geomTol_

◆ propagationTol_

◆ dummyTrackData_

◆ mesh_

◆ explicitConnections_

◆ allFaceInfo_

◆ allCellInfo_

◆ td_

◆ changedFace_

◆ changedCell_

◆ changedFaces_

◆ changedCells_

◆ changedBaffles_

◆ hasCyclicPatches_

◆ hasCyclicAMIPatches_

◆ nEvals_

◆ nUnvisitedCells_

◆ nUnvisitedFaces_

template<class Type, class TrackingData = int>
class Foam::FaceCellWave< Type, TrackingData >