Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
FaceCellWaveBase Class Reference
Inheritance diagram for FaceCellWaveBase:
Inheritance graph
[legend]
Collaboration diagram for FaceCellWaveBase:
Collaboration graph
[legend]

Public Member Functions

 ClassName ("FaceCellWave")
 Runtime type information. More...
 
 FaceCellWaveBase (const polyMesh &mesh)
 Construct with mesh reference and set initial sizes. More...
 
const polyMesh & mesh () const noexcept
 Return access to the mesh. More...
 
label nChangedCells () const noexcept
 Current number of changed cells. More...
 
label nChangedFaces () const noexcept
 Current number of changed faces. More...
 
label nUnvisitedCells () const noexcept
 Get number of unvisited cells, i.e. cells that were not (yet) reached from walking across mesh. More...
 
label nUnvisitedFaces () const noexcept
 Get number of unvisited faces. More...
 

Static Public Member Functions

static scalar propagationTol () noexcept
 Access to propagation tolerance. More...
 
static scalar setPropagationTol (const scalar tol) noexcept
 Change propagation tolerance, return previous value. More...
 

Static Public Attributes

static int dummyTrackData_ = 12345
 Default trackData value (for default template argument) More...
 

Protected Attributes

const polyMesh & mesh_
 Reference to mesh. More...
 
PstreamBuffers pBufs_
 Buffers when updating processor patches. More...
 
bitSet changedFace_
 Track if face has changed. More...
 
bitSet changedCell_
 Track if cell has changed. More...
 
DynamicList< label > changedFaces_
 List of changed faces. More...
 
DynamicList< label > changedCells_
 List of changed cells. More...
 
label nUnvisitedFaces_
 Current count of unvisited faces. More...
 
label nUnvisitedCells_
 Current count of unvisited cells. More...
 

Static Protected Attributes

static const scalar geomTol_ = 1e-6
 
static scalar propagationTol_ = 0.01
 

Detailed Description

Definition at line 67 of file FaceCellWave.H.

Constructor & Destructor Documentation

◆ FaceCellWaveBase()

FaceCellWaveBase ( const polyMesh &  mesh)
explicit

Construct with mesh reference and set initial sizes.

Definition at line 43 of file FaceCellWaveBase.C.

Member Function Documentation

◆ ClassName()

ClassName ( "FaceCellWave"  )

Runtime type information.

◆ propagationTol()

static scalar propagationTol ( )
inlinestaticnoexcept

Access to propagation tolerance.

Definition at line 147 of file FaceCellWave.H.

References FaceCellWaveBase::propagationTol_.

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

Here is the caller graph for this function:

◆ setPropagationTol()

static scalar setPropagationTol ( const scalar  tol)
inlinestaticnoexcept

Change propagation tolerance, return previous value.

Definition at line 155 of file FaceCellWave.H.

References FaceCellWaveBase::propagationTol_.

◆ mesh()

const polyMesh& mesh ( ) const
inlinenoexcept

Return access to the mesh.

Definition at line 168 of file FaceCellWave.H.

References FaceCellWaveBase::mesh_.

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

Here is the caller graph for this function:

◆ nChangedCells()

label nChangedCells ( ) const
inlinenoexcept

Current number of changed cells.

Definition at line 176 of file FaceCellWave.H.

References FaceCellWaveBase::changedCells_, and UList< T >::size().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nChangedFaces()

label nChangedFaces ( ) const
inlinenoexcept

Current number of changed faces.

Definition at line 181 of file FaceCellWave.H.

References FaceCellWaveBase::changedFaces_, and UList< T >::size().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nUnvisitedCells()

label nUnvisitedCells ( ) const
inlinenoexcept

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 192 of file FaceCellWave.H.

References FaceCellWaveBase::nUnvisitedCells_.

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

Here is the caller graph for this function:

◆ nUnvisitedFaces()

label nUnvisitedFaces ( ) const
inlinenoexcept

Get number of unvisited faces.

Definition at line 197 of file FaceCellWave.H.

References FaceCellWaveBase::nUnvisitedFaces_.

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

Here is the caller graph for this function:

Member Data Documentation

◆ geomTol_

const Foam::scalar geomTol_ = 1e-6
staticprotected

Definition at line 73 of file FaceCellWave.H.

◆ propagationTol_

Foam::scalar propagationTol_ = 0.01
staticprotected

Definition at line 74 of file FaceCellWave.H.

Referenced by FaceCellWaveBase::propagationTol(), and FaceCellWaveBase::setPropagationTol().

◆ mesh_

const polyMesh& mesh_
protected

Reference to mesh.

Definition at line 82 of file FaceCellWave.H.

Referenced by FaceCellWaveBase::mesh().

◆ pBufs_

PstreamBuffers pBufs_
protected

Buffers when updating processor patches.

Definition at line 87 of file FaceCellWave.H.

◆ changedFace_

bitSet changedFace_
protected

Track if face has changed.

Definition at line 92 of file FaceCellWave.H.

◆ changedCell_

bitSet changedCell_
protected

Track if cell has changed.

Definition at line 97 of file FaceCellWave.H.

◆ changedFaces_

DynamicList<label> changedFaces_
protected

List of changed faces.

Definition at line 102 of file FaceCellWave.H.

Referenced by FaceCellWaveBase::nChangedFaces().

◆ changedCells_

DynamicList<label> changedCells_
protected

List of changed cells.

Definition at line 107 of file FaceCellWave.H.

Referenced by FaceCellWaveBase::nChangedCells().

◆ nUnvisitedFaces_

label nUnvisitedFaces_
protected

Current count of unvisited faces.

Definition at line 112 of file FaceCellWave.H.

Referenced by FaceCellWaveBase::nUnvisitedFaces().

◆ nUnvisitedCells_

label nUnvisitedCells_
protected

Current count of unvisited cells.

Definition at line 117 of file FaceCellWave.H.

Referenced by FaceCellWaveBase::nUnvisitedCells().

◆ dummyTrackData_

int dummyTrackData_ = 12345
static

Default trackData value (for default template argument)

Definition at line 125 of file FaceCellWave.H.

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