Public Member Functions | List of all members
generatedFaceZone Class Reference

faceZone selection or generation class More...

Public Member Functions

 generatedFaceZone (const polyMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
 generatedFaceZone (const generatedFaceZone &)=delete
 Disallow default bitwise copy construction. More...
 
 ~generatedFaceZone ()
 Destructor. More...
 
const word & name () const
 Return const access to the name of faceZone. More...
 
const faceZone & zone () const
 Return const access to the face set. More...
 
label nFaces () const
 Return the number of faces in the set. More...
 
label facei (const label i) const
 Return the face index corresponding to the face set index. More...
 
void movePoints ()
 Update for mesh motion. More...
 
void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
bool read (const dictionary &dict)
 Read coefficients dictionary. More...
 
void operator= (const generatedFaceZone &)=delete
 Disallow default bitwise assignment. More...
 

Detailed Description

faceZone selection or generation class

The faceZone is either looked-up from the mesh or generated by a zoneGenerator and stored locally.

Usage
Examples: 
    // Select the faces within the faceZone rotor
    faceZone rotor;

    // Select the faces within the given box
    faceZone
    {
        type        box;
        box         (3.48 -0.1 -0.1) (3.5 0.1 0.1);
    }

    // Select the faces representing the given plane
    faceZone
    {
        type        plane;
        point       (0.41 0 0);
        normal      (1 0 0);
    }
See also
Foam::generatedZoneSet Foam::zoneGenerator
Source files

Definition at line 82 of file generatedFaceZone.H.

Constructor & Destructor Documentation

◆ generatedFaceZone() [1/2]

generatedFaceZone ( const polyMesh &  mesh,
const dictionary &  dict 
)

Construct from mesh and dictionary.

Definition at line 32 of file generatedFaceZone.C.

References dict, and generatedFaceZone::read().

Here is the call graph for this function:

◆ generatedFaceZone() [2/2]

generatedFaceZone ( const generatedFaceZone &  )
delete

Disallow default bitwise copy construction.

◆ ~generatedFaceZone()

~generatedFaceZone ( )

Destructor.

Definition at line 46 of file generatedFaceZone.C.

Member Function Documentation

◆ name()

const Foam::word & name ( ) const
inline

Return const access to the name of faceZone.

Definition at line 30 of file generatedFaceZoneI.H.

References zoneSet::fZone(), and Zone< ZoneType, ZonesType >::name().

Here is the call graph for this function:

◆ zone()

const Foam::faceZone & zone ( ) const
inline

Return const access to the face set.

Definition at line 36 of file generatedFaceZoneI.H.

◆ nFaces()

Foam::label nFaces ( ) const
inline

Return the number of faces in the set.

Definition at line 42 of file generatedFaceZoneI.H.

◆ facei()

Foam::label facei ( const label  i) const
inline

Return the face index corresponding to the face set index.

Definition at line 48 of file generatedFaceZoneI.H.

◆ movePoints()

void movePoints ( )

Update for mesh motion.

Definition at line 52 of file generatedFaceZone.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  map)

Update topology using the given map.

Definition at line 58 of file generatedFaceZone.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap &  map)

Update from another mesh using the given map.

Definition at line 64 of file generatedFaceZone.C.

◆ distribute()

void distribute ( const polyDistributionMap &  map)

Redistribute or update using the given distribution map.

Definition at line 70 of file generatedFaceZone.C.

◆ read()

bool read ( const dictionary &  dict)

Read coefficients dictionary.

Definition at line 76 of file generatedFaceZone.C.

References dict, and Foam::face.

Referenced by generatedFaceZone::generatedFaceZone().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const generatedFaceZone &  )
delete

Disallow default bitwise assignment.

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