surface Class Reference

A faceZone zoneGenerator which selects faces based on the intersection of a surface with the vector between the adjacent cell centres. More...

Inheritance diagram for surface:
Collaboration diagram for surface:

Public Member Functions

 TypeName ("surface")
 Runtime type information. More...
 
 surface (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~surface ()
 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 faceZone zoneGenerator which selects faces based on the intersection of a surface with the vector between the adjacent cell centres.

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
surface searchableSurface type yes
tol cell-cell vector intersection tolerance no rootSmall
moveUpdate Switch to update after mesh motion no false

To create the faceZone baffles containing the faces based on the adjacent cell centres spanning the given triangulated surface:

        baffles
        {
            type        surface;
            surface     triSurface;
            file        "baffles.obj";
        }

To create the faceZone rotatingZone containing the faces based on the adjacent cell centres spanning the given cylinder:

        rotatingZone
        {
            type        surface;
            surface     cylinder;
            point1      (0 0 0.54);
            point2      (0 0 0.66);
            radius      0.2;
        }
See also
searchableSurface zoneGenerators::plane_zoneGenerator
Source files

Definition at line 124 of file surface_zoneGenerator.H.

Constructor & Destructor Documentation

◆ surface()

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

Construct from dictionary.

Definition at line 52 of file surface_zoneGenerator.C.

◆ ~surface()

~surface ( )
virtual

Destructor.

Definition at line 87 of file surface_zoneGenerator.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surface"  )

Runtime type information.

◆ generate()

Foam::zoneSet generate ( ) const
virtual

Generate and return the zoneSet.

Implements zoneGenerator.

Definition at line 93 of file surface_zoneGenerator.C.

References forAll, patchi, List< T >::resize(), List< T >::setSize(), Foam::sign(), List< T >::size(), syncTools::swapBoundaryCellList(), and syncTools::swapBoundaryCellPositions().

Here is the call graph for this function:

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