face Class Reference

A zoneGenerator which converts the point, cell and face zones from a list of zoneGenerators into a faceZone. More...

Inheritance diagram for face:
Collaboration diagram for face:

Public Types

enum class  cellFaces { all , inner , outer , outerInternal }
 Enumeration defining the valid options. More...
 

Public Member Functions

 TypeName ("face")
 Runtime type information. More...
 
 face (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~face ()
 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...
 

Static Public Attributes

static const NamedEnum< cellFaces, 4 > cellFacesNames
 Names of the valid options. 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 the point, cell and face zones from a list of zoneGenerators into a faceZone.

If a faceZone with the same name as the faceZone to be generated is returned by a zoneGenerator in the list it is ignored.

The returned faceZone is oriented and provides the corresponding flipMap.

Usage
Property Description Required Default value
type Type: face yes
name Name of the zone no zoneGenerator name
cellFaces Cell face selection option no all
moveUpdate Switch to update after mesh motion no false

cellFaces face selection controls:

Option Description
all Select all faces of the cells in the cellZone
inner Select the faces inside the cellZone
outer Select the faces on the outer surface of the cellZone
outerInternal Select the internal faces on the outer surface of the cellZone

To convert cellZone named cone1 generated by

        cone1
        {
            type        truncatedCone;
            zoneType    cell;

            point1      (-0.0075 0 -1);
            point2      (-0.003 0.0025 1);
            radius1     0.001;
            radius2     0.0005;
        }

into a faceZone also named cone1, the following zoneGenerator named cone1Faces can be used

        cone1Faces
        {
            type        face;
            name        cone1;

            cone1;
        }

To create a faceZone which includes only the internal mesh faces on the outer surface of a pre-generated cellZone named leftFluid the outerInternal cellFaces face selection option can be used:

        cycLeft
        {
            type        face;
            cellFaces   outerInternal;
            leftFluid;
        }
Source files

Definition at line 150 of file face_zoneGenerator.H.

Member Enumeration Documentation

◆ cellFaces

enum cellFaces
strong

Enumeration defining the valid options.

Enumerator
all 
inner 
outer 
outerInternal 

Definition at line 157 of file face_zoneGenerator.H.

Constructor & Destructor Documentation

◆ face()

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

Construct from dictionary.

Definition at line 62 of file face_zoneGenerator.C.

References Foam::all.

◆ ~face()

~face ( )
virtual

Destructor.

Definition at line 85 of file face_zoneGenerator.C.

Member Function Documentation

◆ TypeName()

TypeName ( "face"  )

Runtime type information.

◆ generate()

Member Data Documentation

◆ cellFacesNames

const Foam::NamedEnum< Foam::zoneGenerators::face::cellFaces, 4 > cellFacesNames
static
Initial value:
{
"all",
"inner",
"outer",
"outerInternal"
}

Names of the valid options.

Definition at line 166 of file face_zoneGenerator.H.


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