MeshWave< Type, TrackingData > Class Template Reference

FaceCellWave plus data. More...

#include <MeshWave.H>

Inheritance diagram for MeshWave< Type, TrackingData >:

Collaboration diagram for MeshWave< Type, TrackingData >:

Public Member Functions
	MeshWave (const polyMesh &mesh, const labelUList &initialChangedFaces, const UList< Type > &changedFacesInfo, const label maxIter, TrackingData &td=FaceCellWaveBase::dummyTrackData_)
	Construct from mesh and list of changed faces with the Type for these faces.
	MeshWave (const polyMesh &mesh, const labelUList &initialChangedFaces, const UList< Type > &changedFacesInfo, const UList< Type > &allCellInfo, const label maxIter, TrackingData &td=FaceCellWaveBase::dummyTrackData_)
	Construct from mesh, list of changed faces with the Type for these faces and initial field.
const List< Type > &	allFaceInfo () const noexcept
	Get allFaceInfo.
const List< Type > &	allCellInfo () const noexcept
	Get allCellInfo.
const TrackingData &	data () const noexcept
	Additional data to be passed into container.
label	iterate (const label maxIter)
	Iterate until no changes or maxIter reached.
label	nChangedCells () const noexcept
	Current number of changed cells.
label	nChangedFaces () const noexcept
	Current number of changed faces.
label	nUnvisitedCells () const noexcept
	Number of unvisited cells.
label	nUnvisitedFaces () const noexcept
	Number of unvisited faces.

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

Constructor & Destructor Documentation

MeshWave() [1/2]

template<class Type, class TrackingData>

MeshWave	(	const polyMesh &	mesh,
		const labelUList &	initialChangedFaces,
		const UList< Type > &	changedFacesInfo,
		const label	maxIter,
		TrackingData &	td = FaceCellWaveBase::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 29 of file MeshWave.C.

References mesh, and td().

Here is the call graph for this function:

MeshWave() [2/2]

template<class Type, class TrackingData>

MeshWave	(	const polyMesh &	mesh,
		const labelUList &	initialChangedFaces,
		const UList< Type > &	changedFacesInfo,
		const UList< Type > &	allCellInfo,
		const label	maxIter,
		TrackingData &	td = FaceCellWaveBase::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 56 of file MeshWave.C.

References allCellInfo(), mesh, and td().

Here is the call graph for this function:

Member Function Documentation

allFaceInfo()

template<class Type, class TrackingData = int>

const List< Type > & allFaceInfo ( ) const

inlinenoexcept

Get allFaceInfo.

Definition at line 133 of file MeshWave.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

allCellInfo()

template<class Type, class TrackingData = int>

const List< Type > & allCellInfo ( ) const

inlinenoexcept

Get allCellInfo.

Definition at line 141 of file MeshWave.H.

References Foam::noexcept.

Referenced by inverseFaceDistanceDiffusivity::correct(), MeshWave(), and wallLayerCells::wallLayerCells().

Here is the caller graph for this function:

data()

template<class Type, class TrackingData = int>

const TrackingData & data ( ) const

inlinenoexcept

Additional data to be passed into container.

Definition at line 149 of file MeshWave.H.

References Foam::noexcept.

Referenced by wallLayerCells::wallLayerCells().

Here is the caller graph for this function:

iterate()

template<class Type, class TrackingData = int>

label iterate ( const label maxIter )

inline

Iterate until no changes or maxIter reached.

Returns

actual number of iterations.

Definition at line 159 of file MeshWave.H.

Referenced by wallLayerCells::wallLayerCells().

Here is the caller graph for this function:

nChangedCells()

template<class Type, class TrackingData = int>

label nChangedCells ( ) const

inlinenoexcept

Current number of changed cells.

Definition at line 167 of file MeshWave.H.

References Foam::noexcept.

nChangedFaces()

template<class Type, class TrackingData = int>

label nChangedFaces ( ) const

inlinenoexcept

Current number of changed faces.

Definition at line 172 of file MeshWave.H.

References Foam::noexcept.

nUnvisitedCells()

template<class Type, class TrackingData = int>

label nUnvisitedCells ( ) const

inlinenoexcept

Number of unvisited cells.

Definition at line 177 of file MeshWave.H.

References Foam::noexcept.

nUnvisitedFaces()

template<class Type, class TrackingData = int>

label nUnvisitedFaces ( ) const

inlinenoexcept

Number of unvisited faces.

Definition at line 185 of file MeshWave.H.

References Foam::noexcept.

---

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

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