MeshWave< Type, TrackingData > Class Template Reference

FaceCellWave plus data. More...

Inheritance diagram for MeshWave< Type, TrackingData >:

Collaboration diagram for MeshWave< Type, TrackingData >:

Public Member Functions
	MeshWave (const polyMesh &mesh, const labelList &initialChangedFaces, const List< Type > &changedFacesInfo, const label maxIter, TrackingData &td=dummyTrackData_)
	Construct from mesh and list of changed faces with the Type. More...
	MeshWave (const polyMesh &mesh, const labelList &initialChangedFaces, const List< Type > &changedFacesInfo, const List< Type > &allCellInfo, const label maxIter, TrackingData &td=dummyTrackData_)
	Construct from mesh, list of changed faces with the Type. More...
const List< Type > &	allFaceInfo () const
	Get allFaceInfo. More...
const List< Type > &	allCellInfo () const
	Get allCellInfo. More...
const TrackingData &	data () const
	Additional data to be passed into container. More...
label	iterate (const label maxIter)
	Iterate until no changes or maxIter reached. Returns actual. More...
label	getUnsetCells () const
	Get number of unvisited cells, i.e. cells that were not (yet) More...
label	getUnsetFaces () const
	Get number of unvisited faces. More...

Private Member Functions
	MeshWave (const MeshWave &)
	Disallow default bitwise copy construct. More...
void	operator= (const MeshWave &)
	Disallow default bitwise assignment. More...

Private Attributes
List< Type >	allFaceInfo_
	Wall information for all faces. More...
List< Type >	allCellInfo_
	Wall information for all cells. More...
FaceCellWave< Type, TrackingData >	calc_
	Wave calculation engine. More...

Static Private Attributes
static int	dummyTrackData_ = 12345
	Used as default trackdata value to satisfy default template. More...

Detailed Description

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

FaceCellWave plus data.

Source files

• MeshWave.H
• MeshWave.C

Definition at line 56 of file MeshWave.H.

Constructor & Destructor Documentation

MeshWave() [1/3]

MeshWave ( const MeshWave< Type, TrackingData > &  )

private

Disallow default bitwise copy construct.

MeshWave() [2/3]

MeshWave	(	const polyMesh &	mesh,
		const labelList &	initialChangedFaces,
		const List< Type > &	changedFacesInfo,
		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)

Definition at line 42 of file MeshWave.C.

MeshWave() [3/3]

MeshWave	(	const polyMesh &	mesh,
		const labelList &	initialChangedFaces,
		const List< Type > &	changedFacesInfo,
		const List< Type > &	allCellInfo,
		const label	maxIter,
		TrackingData &	td = dummyTrackData_
	)

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

for these faces and initial field. Iterates until nothing changes or maxIter reached. (maxIter can be 0)

Definition at line 69 of file MeshWave.C.

Member Function Documentation

operator=()

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

private

Disallow default bitwise assignment.

allFaceInfo()

const List<Type>& allFaceInfo ( ) const

inline

Get allFaceInfo.

Definition at line 119 of file MeshWave.H.

References MeshWave< Type, TrackingData >::allFaceInfo_.

Referenced by inverseFaceDistanceDiffusivity::correct(), patchDataWave< TransferType >::correct(), patchWave::getValues(), patchDataWave< TransferType >::getValues(), and wallLayerCells::wallLayerCells().

Here is the caller graph for this function:

allCellInfo()

const List<Type>& allCellInfo ( ) const

inline

Get allCellInfo.

Definition at line 125 of file MeshWave.H.

References MeshWave< Type, TrackingData >::allCellInfo_.

Referenced by inverseFaceDistanceDiffusivity::correct(), patchWave::getValues(), patchDataWave< TransferType >::getValues(), cellClassification::markCells(), directions::propagateDirection(), and wallLayerCells::wallLayerCells().

Here is the caller graph for this function:

data()

const TrackingData& data ( ) const

inline

Additional data to be passed into container.

Definition at line 131 of file MeshWave.H.

References MeshWave< Type, TrackingData >::calc_.

Referenced by patchWave::getValues(), patchDataWave< TransferType >::getValues(), and wallLayerCells::wallLayerCells().

Here is the caller graph for this function:

iterate()

label iterate ( const label  maxIter )

inline

Iterate until no changes or maxIter reached. Returns actual.

number of iterations.

Definition at line 138 of file MeshWave.H.

Referenced by wallLayerCells::wallLayerCells().

Here is the caller graph for this function:

getUnsetCells()

label getUnsetCells ( ) const

inline

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 148 of file MeshWave.H.

getUnsetFaces()

label getUnsetFaces ( ) const

inline

Get number of unvisited faces.

Definition at line 154 of file MeshWave.H.

References MeshWave< Type, TrackingData >::calc_.

Field Documentation

allFaceInfo_

List<Type> allFaceInfo_

private

Wall information for all faces.

Definition at line 63 of file MeshWave.H.

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

allCellInfo_

List<Type> allCellInfo_

private

Wall information for all cells.

Definition at line 66 of file MeshWave.H.

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

calc_

FaceCellWave<Type, TrackingData> calc_

private

Wave calculation engine.

Definition at line 69 of file MeshWave.H.

Referenced by MeshWave< Type, TrackingData >::data(), and MeshWave< Type, TrackingData >::getUnsetFaces().

dummyTrackData_

int dummyTrackData_ = 12345

staticprivate

Used as default trackdata value to satisfy default template.

argument.

Definition at line 83 of file MeshWave.H.

---

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

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