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

Public Member Functions

 ClassName ("PointEdgeWave")
 Runtime type information. More...
 
 PointEdgeWaveBase (const polyMesh &mesh)
 Construct with mesh reference and set initial sizes. More...
 
const polyMesh & mesh () const noexcept
 Return access to the mesh. More...
 
label nChangedPoints () const noexcept
 Current number of changed points. More...
 
label nChangedEdges () const noexcept
 Current number of changed edges. More...
 
label nUnvisitedEdges () const noexcept
 Number of unvisited edges, i.e. edges that were not (yet) reached from walking across mesh. More...
 
label nUnvisitedPoints () const noexcept
 Get number of unvisited points. 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 changedPoint_
 Track if point has changed. More...
 
bitSet changedEdge_
 Track if edge has changed. More...
 
DynamicList< label > changedPoints_
 List of changed points. More...
 
DynamicList< label > changedEdges_
 List of changed edges. More...
 
label nUnvisitedPoints_
 Number of unvisited points. More...
 
label nUnvisitedEdges_
 Number of unvisited edges. More...
 

Static Protected Attributes

static scalar propagationTol_ = 0.01
 Relative tolerance. More...
 

Detailed Description

Definition at line 77 of file PointEdgeWave.H.

Constructor & Destructor Documentation

◆ PointEdgeWaveBase()

PointEdgeWaveBase ( const polyMesh &  mesh)
explicit

Construct with mesh reference and set initial sizes.

Definition at line 41 of file PointEdgeWaveBase.C.

Member Function Documentation

◆ ClassName()

ClassName ( "PointEdgeWave"  )

Runtime type information.

◆ propagationTol()

static scalar propagationTol ( )
inlinestaticnoexcept

Access to propagation tolerance.

Definition at line 162 of file PointEdgeWave.H.

References PointEdgeWaveBase::propagationTol_.

◆ setPropagationTol()

static scalar setPropagationTol ( const scalar  tol)
inlinestaticnoexcept

Change propagation tolerance, return previous value.

Definition at line 170 of file PointEdgeWave.H.

References PointEdgeWaveBase::propagationTol_.

◆ mesh()

const polyMesh& mesh ( ) const
inlinenoexcept

Return access to the mesh.

Definition at line 183 of file PointEdgeWave.H.

References PointEdgeWaveBase::mesh_.

◆ nChangedPoints()

label nChangedPoints ( ) const
inlinenoexcept

Current number of changed points.

Definition at line 188 of file PointEdgeWave.H.

References PointEdgeWaveBase::changedPoints_, and UList< T >::size().

Here is the call graph for this function:

◆ nChangedEdges()

label nChangedEdges ( ) const
inlinenoexcept

Current number of changed edges.

Definition at line 193 of file PointEdgeWave.H.

References PointEdgeWaveBase::changedEdges_, and UList< T >::size().

Here is the call graph for this function:

◆ nUnvisitedEdges()

label nUnvisitedEdges ( ) const
inlinenoexcept

Number of unvisited edges, i.e. edges 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 204 of file PointEdgeWave.H.

References PointEdgeWaveBase::nUnvisitedEdges_.

◆ nUnvisitedPoints()

label nUnvisitedPoints ( ) const
inlinenoexcept

Get number of unvisited points.

Definition at line 209 of file PointEdgeWave.H.

References PointEdgeWaveBase::nUnvisitedPoints_.

Member Data Documentation

◆ propagationTol_

Foam::scalar propagationTol_ = 0.01
staticprotected

Relative tolerance.

Stop propagation if relative changes less than this tolerance (responsibility for checking this is up to Type implementation)

Definition at line 89 of file PointEdgeWave.H.

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

◆ mesh_

const polyMesh& mesh_
protected

Reference to mesh.

Definition at line 97 of file PointEdgeWave.H.

Referenced by PointEdgeWaveBase::mesh().

◆ pBufs_

PstreamBuffers pBufs_
protected

Buffers when updating processor patches.

Definition at line 102 of file PointEdgeWave.H.

◆ changedPoint_

bitSet changedPoint_
protected

Track if point has changed.

Definition at line 107 of file PointEdgeWave.H.

◆ changedEdge_

bitSet changedEdge_
protected

Track if edge has changed.

Definition at line 112 of file PointEdgeWave.H.

◆ changedPoints_

DynamicList<label> changedPoints_
protected

List of changed points.

Definition at line 117 of file PointEdgeWave.H.

Referenced by PointEdgeWaveBase::nChangedPoints().

◆ changedEdges_

DynamicList<label> changedEdges_
protected

List of changed edges.

Definition at line 122 of file PointEdgeWave.H.

Referenced by PointEdgeWaveBase::nChangedEdges().

◆ nUnvisitedPoints_

label nUnvisitedPoints_
protected

Number of unvisited points.

Definition at line 127 of file PointEdgeWave.H.

Referenced by PointEdgeWaveBase::nUnvisitedPoints().

◆ nUnvisitedEdges_

label nUnvisitedEdges_
protected

Number of unvisited edges.

Definition at line 132 of file PointEdgeWave.H.

Referenced by PointEdgeWaveBase::nUnvisitedEdges().

◆ dummyTrackData_

int dummyTrackData_ = 12345
static

Default trackData value (for default template argument)

Definition at line 140 of file PointEdgeWave.H.

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