set Class Reference

A zoneGenerator which converts a set into the corresponding zone. More...

Inheritance diagram for set:
Collaboration diagram for set:

Public Member Functions

 TypeName ("set")
 Runtime type information. More...
 
 set (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~set ()
 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
 
const wordzoneName () const
 
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 converts a set into the corresponding zone.

The faceZone generated from a face set is unoriented because face sets do not provide the orientation flipMap.

Usage
Property Description Required Default value
type Type: set yes
name Name of the zone no zoneGenerator name
setName Name of the set no zone name
zoneType Type of set/zone yes

Create a cellZone named setCells containing the cells in the set:

        setCells
        {
            type        set;
            zoneType    cell;
            setName     boxCells;
        }

of if the zoneGenerator, cellZone and set all have the name boxCells this simpler specification can be used:

        boxCells
        {
            type        set;
            zoneType    cell;
        }
Source files

Definition at line 106 of file set.H.

Constructor & Destructor Documentation

◆ set()

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

Construct from dictionary.

Definition at line 47 of file set.C.

◆ ~set()

~set ( )
virtual

Destructor.

Definition at line 62 of file set.C.

Member Function Documentation

◆ TypeName()

TypeName ( "set"  )

Runtime type information.

◆ generate()

Foam::zoneSet generate ( ) const
virtual

Generate and return the zoneSet.

Implements zoneGenerator.

Definition at line 68 of file set.C.

References Foam::cell, Foam::face, and Foam::point.


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