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

Public Member Functions

 ClassName ("PatchEdgeFaceWave")
 Runtime type information. More...
 
 PatchEdgeFaceWaveBase (const polyMesh &mesh, const label nEdges, const label nFaces)
 Construct with mesh reference and set initial sizes. More...
 
const polyMesh & mesh () const noexcept
 Return access to the mesh. More...
 
label nChangedEdges () const noexcept
 Current number of changed edges. More...
 
label nChangedFaces () const noexcept
 Current number of changed faces. More...
 
label nUnvisitedFaces () const noexcept
 Number of unvisited faces, i.e. faces that were not (yet) reached from walking across patch. More...
 
label nUnvisitedEdges () const noexcept
 

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 label dummyTrackData_ = 12345
 Default trackData value (for default template argument) More...
 

Protected Attributes

const polyMesh & mesh_
 Reference to mesh. More...
 
bitSet changedEdge_
 Track if edge has changed. More...
 
bitSet changedFace_
 Track if face has changed. More...
 
DynamicList< label > changedEdges_
 List of changed edges. More...
 
DynamicList< label > changedFaces_
 List of changed faces. More...
 
label nUnvisitedEdges_
 Number of unvisited edges. More...
 
label nUnvisitedFaces_
 Number of unvisited faces. More...
 

Static Protected Attributes

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

Detailed Description

Definition at line 55 of file PatchEdgeFaceWave.H.

Constructor & Destructor Documentation

◆ PatchEdgeFaceWaveBase()

PatchEdgeFaceWaveBase ( const polyMesh &  mesh,
const label  nEdges,
const label  nFaces 
)

Construct with mesh reference and set initial sizes.

Definition at line 43 of file PatchEdgeFaceWaveBase.C.

Member Function Documentation

◆ ClassName()

ClassName ( "PatchEdgeFaceWave"  )

Runtime type information.

◆ propagationTol()

static scalar propagationTol ( )
inlinestaticnoexcept

Access to propagation tolerance.

Definition at line 140 of file PatchEdgeFaceWave.H.

References PatchEdgeFaceWaveBase::propagationTol_.

◆ setPropagationTol()

static scalar setPropagationTol ( const scalar  tol)
inlinestaticnoexcept

Change propagation tolerance, return previous value.

Definition at line 148 of file PatchEdgeFaceWave.H.

References PatchEdgeFaceWaveBase::propagationTol_.

◆ mesh()

const polyMesh& mesh ( ) const
inlinenoexcept

Return access to the mesh.

Definition at line 161 of file PatchEdgeFaceWave.H.

References PatchEdgeFaceWaveBase::mesh_.

◆ nChangedEdges()

label nChangedEdges ( ) const
inlinenoexcept

Current number of changed edges.

Definition at line 166 of file PatchEdgeFaceWave.H.

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

Here is the call graph for this function:

◆ nChangedFaces()

label nChangedFaces ( ) const
inlinenoexcept

Current number of changed faces.

Definition at line 171 of file PatchEdgeFaceWave.H.

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

Here is the call graph for this function:

◆ nUnvisitedFaces()

label nUnvisitedFaces ( ) const
inlinenoexcept

Number of unvisited faces, i.e. faces that were not (yet) reached from walking across patch.

This can happen from

  • not enough iterations done
  • a disconnected patch
  • a patch without walls in it

Definition at line 183 of file PatchEdgeFaceWave.H.

References PatchEdgeFaceWaveBase::nUnvisitedFaces_.

◆ nUnvisitedEdges()

label nUnvisitedEdges ( ) const
inlinenoexcept

Definition at line 185 of file PatchEdgeFaceWave.H.

References PatchEdgeFaceWaveBase::nUnvisitedEdges_.

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 67 of file PatchEdgeFaceWave.H.

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

◆ mesh_

const polyMesh& mesh_
protected

Reference to mesh.

Definition at line 75 of file PatchEdgeFaceWave.H.

Referenced by PatchEdgeFaceWaveBase::mesh().

◆ changedEdge_

bitSet changedEdge_
protected

Track if edge has changed.

Definition at line 80 of file PatchEdgeFaceWave.H.

◆ changedFace_

bitSet changedFace_
protected

Track if face has changed.

Definition at line 85 of file PatchEdgeFaceWave.H.

◆ changedEdges_

DynamicList<label> changedEdges_
protected

List of changed edges.

Definition at line 90 of file PatchEdgeFaceWave.H.

Referenced by PatchEdgeFaceWaveBase::nChangedEdges().

◆ changedFaces_

DynamicList<label> changedFaces_
protected

List of changed faces.

Definition at line 95 of file PatchEdgeFaceWave.H.

Referenced by PatchEdgeFaceWaveBase::nChangedFaces().

◆ nUnvisitedEdges_

label nUnvisitedEdges_
protected

Number of unvisited edges.

Definition at line 100 of file PatchEdgeFaceWave.H.

Referenced by PatchEdgeFaceWaveBase::nUnvisitedEdges().

◆ nUnvisitedFaces_

label nUnvisitedFaces_
protected

Number of unvisited faces.

Definition at line 105 of file PatchEdgeFaceWave.H.

Referenced by PatchEdgeFaceWaveBase::nUnvisitedFaces().

◆ dummyTrackData_

Foam::label dummyTrackData_ = 12345
static

Default trackData value (for default template argument)

Definition at line 113 of file PatchEdgeFaceWave.H.

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