nearPatchCells Class Reference

A zoneGenerator which constructs a cellZone of the cells within a distance from a set of patches. More...

Inheritance diagram for nearPatchCells:
Collaboration diagram for nearPatchCells:

Public Member Functions

 TypeName ("nearPatchCells")
 Runtime type information. More...
 
 nearPatchCells (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~nearPatchCells ()
 Destructor. More...
 
virtual zoneSet generate () const
 Generate and return the zoneSet. More...
 
- Public Member Functions inherited from zoneGenerator
 TypeName ("zoneGenerator")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, zoneGenerator, dictionary,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict))
 
 zoneGenerator (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from name, polyMesh and dictionary. More...
 
 zoneGenerator (const zoneGenerator &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~zoneGenerator ()
 Destructor. More...
 
const wordname () const
 Return the zoneGenerator name. More...
 
const wordzoneName () const
 Return the zone name. More...
 
const polyMeshmesh () const
 Return reference to the polyMesh. More...
 
bool moveUpdate () const
 Return true if the zoneGenerator updates any of the zones. More...
 
virtual zoneSet movePoints () const
 Regenerate the zoneSet following mesh point motion. More...
 
void operator= (const zoneGenerator &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from zoneGenerator
static autoPtr< zoneGeneratorNew (const word &name, const polyMesh &mesh, const dictionary &dict)
 Select constructed from name, mesh and dictionary. More...
 
static autoPtr< zoneGeneratorNew (const word &name, const zoneTypes &zoneType, const polyMesh &mesh, const dictionary &dict)
 Select constructed from name, zoneType, mesh and dictionary. More...
 
static autoPtr< zoneGeneratorNew (const polyMesh &mesh, const dictionary &dict)
 Select constructed from mesh and first valid dictionary. More...
 
static labelList indices (const boolList &selected)
 Return the list of selected indices. More...
 
- Protected Attributes inherited from zoneGenerator
const word name_
 Name of zone generator. More...
 
const dictionary dict_
 Dictionary cached for error context. More...
 
const word zoneName_
 Name of the zone (defaults to the name of the generator) More...
 
const polyMeshmesh_
 Reference to the polyMesh. More...
 
bool moveUpdate_
 Switch to update the zones if the mesh points are moved. More...
 

Detailed Description

A zoneGenerator which constructs a cellZone of the cells within a distance from a set of patches.

Usage
Property Description Required Default value
type Type: nearPatchCells yes
name Name of the zone no zoneGenerator name
patch Name of patch no
patches List of patch names no ()
distance Distance from the patch yes
moveUpdate Switch to update after mesh motion no false

To select all cells within one centimetre of a patch named walls:

        nearToWalls
        {
            type        nearPatchCells;
            patch       walls;
            distance    1 [cm];
        }
Source files

Definition at line 107 of file nearPatchCells_zoneGenerator.H.

Constructor & Destructor Documentation

◆ nearPatchCells()

nearPatchCells ( const word name,
const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 48 of file nearPatchCells_zoneGenerator.C.

◆ ~nearPatchCells()

~nearPatchCells ( )
virtual

Destructor.

Definition at line 63 of file nearPatchCells_zoneGenerator.C.

Member Function Documentation

◆ TypeName()

TypeName ( "nearPatchCells"  )

Runtime type information.

◆ generate()

Foam::zoneSet generate ( ) const
virtual

Generate and return the zoneSet.

Implements zoneGenerator.

Definition at line 69 of file nearPatchCells_zoneGenerator.C.

References Foam::patchDistWave::calculate(), and Foam::selectIndices().

Here is the call graph for this function:

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