Public Member Functions | List of all members
faceZoneToFaceZone Class Reference

A topoSetSource to select faces of a given faceZone. More...

Inheritance diagram for faceZoneToFaceZone:
Inheritance graph
[legend]
Collaboration diagram for faceZoneToFaceZone:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("faceZoneToFaceZone")
 
 faceZoneToFaceZone (const polyMesh &mesh, const word &setName)
 
 faceZoneToFaceZone (const polyMesh &mesh, const dictionary &dict)
 
 faceZoneToFaceZone (const polyMesh &mesh, Istream &is)
 
virtual ~faceZoneToFaceZone ()=default
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &set) const
 
- Public Member Functions inherited from topoSetFaceZoneSource
 declareRunTimeSelectionTable (autoPtr, topoSetFaceZoneSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
 
 declareRunTimeSelectionTable (autoPtr, topoSetFaceZoneSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
 
 topoSetFaceZoneSource (const polyMesh &mesh)
 
 topoSetFaceZoneSource (const polyMesh &mesh, const dictionary &dict)
 
autoPtr< topoSetFaceZoneSourceclone () const
 
virtual ~topoSetFaceZoneSource ()=default
 
virtual topoSetSource::sourceType setType () const
 
- Public Member Functions inherited from topoSetSource
 TypeName ("topoSetSource")
 
 declareRunTimeSelectionTable (autoPtr, topoSetSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
 
 declareRunTimeSelectionTable (autoPtr, topoSetSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
 
 topoSetSource (const polyMesh &mesh, bool verbose=true)
 
 topoSetSource (const polyMesh &mesh, const dictionary &dict)
 
autoPtr< topoSetSourceclone () const
 
virtual ~topoSetSource ()=default
 
const polyMeshmesh () const noexcept
 
bool verbose () const noexcept
 
bool verbose (bool on) noexcept
 
void verbose (const dictionary &dict)
 

Additional Inherited Members

- Public Types inherited from topoSetSource
enum  sourceType {
  UNKNOWN_SOURCE = 0, CELL_TYPE = 0x1, FACE_TYPE = 0x2, POINT_TYPE = 0x4,
  SET_SOURCE = 0x10, CELLSET_SOURCE = (CELL_TYPE | SET_SOURCE), FACESET_SOURCE = (FACE_TYPE | SET_SOURCE), POINTSET_SOURCE = (POINT_TYPE | SET_SOURCE),
  ZONE_SOURCE = 0x20, CELLZONE_SOURCE = (CELL_TYPE | ZONE_SOURCE), FACEZONE_SOURCE = (FACE_TYPE | ZONE_SOURCE), POINTZONE_SOURCE = (POINT_TYPE | ZONE_SOURCE),
  CELLSETSOURCE = CELLSET_SOURCE, FACESETSOURCE = FACESET_SOURCE, POINTSETSOURCE = POINTSET_SOURCE, CELLZONESOURCE = CELLZONE_SOURCE,
  FACEZONESOURCE = FACEZONE_SOURCE, POINTZONESOURCE = POINTZONE_SOURCE
}
 
enum  setAction {
  ADD, NEW, SUBTRACT, SUBSET,
  INVERT, CLEAR, REMOVE, LIST,
  DELETE = SUBTRACT
}
 
- Static Public Member Functions inherited from topoSetFaceZoneSource
static autoPtr< topoSetFaceZoneSourceNew (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
 
static autoPtr< topoSetFaceZoneSourceNew (const word &sourceType, const polyMesh &mesh, Istream &is)
 
- Static Public Member Functions inherited from topoSetSource
static IstreamcheckIs (Istream &is)
 
static bool isSetSource (const sourceType t) noexcept
 
static bool isZoneSource (const sourceType t) noexcept
 
static bool isCell (const sourceType t) noexcept
 
static bool isFace (const sourceType t) noexcept
 
static bool isPoint (const sourceType t) noexcept
 
static const stringusage (const word &name)
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
 
static setAction toAction (const word &actionName)
 
- Static Public Attributes inherited from topoSetSource
static const Enum< setActionactionNames
 
- Protected Member Functions inherited from topoSetSource
void addOrDelete (topoSet &set, const label id, const bool add) const
 
void addOrDelete (topoSet &set, const labelUList &labels, const bool add) const
 
void addOrDelete (topoSet &set, const bitSet &labels, const bool add) const
 
 topoSetSource (const topoSetSource &)=delete
 
void operator= (const topoSetSource &)=delete
 
- Static Protected Member Functions inherited from topoSetSource
static bool check (labelList &list, const label maxLabel)
 
- Protected Attributes inherited from topoSetSource
const polyMeshmesh_
 
bool verbose_
 
- Static Protected Attributes inherited from topoSetSource
static const string illegalSource_
 
static HashTable< string > * usageTablePtr_ = nullptr
 

Detailed Description

A topoSetSource to select faces of a given faceZone.

Operands:

Operand Type Location
input faceSet $FOAM_CASE/constant/polyMesh/sets/<set>
output 1 faceSet $FOAM_CASE/constant/polyMesh/sets/<set>
output 2 faceZone $FOAM_CASE/constant/polyMesh/faceZones
Usage
Minimal example by using system/topoSetDict.actions:
{
    // Mandatory (inherited) entries
    name        <name>;
    type        faceZoneSet;
    action      <action>;

    // Mandatory entries
    source      faceZoneToFaceZone;
    zone        <faceZoneName>;
}

where the entries mean:

Property Description Type Req'd Dflt
name Name of faceZone word yes -
type Type name: faceZoneSet word yes -
action Action applied on faces - see below word yes -
source Source name: faceZoneToFaceZone word yes -
zone Name of input faceZone word yes -

Options for the action entry:

      new      | Create a new faceZone from selected faces of a faceZone
      add      | Add selected faces of a faceZone into this faceZone
      subtract | Remove selected faces of a faceZone from this faceZone
See also
Source files

Definition at line 142 of file faceZoneToFaceZone.H.

Constructor & Destructor Documentation

◆ faceZoneToFaceZone() [1/3]

faceZoneToFaceZone ( const polyMesh mesh,
const word setName 
)

Definition at line 61 of file faceZoneToFaceZone.C.

◆ faceZoneToFaceZone() [2/3]

faceZoneToFaceZone ( const polyMesh mesh,
const dictionary dict 
)

Definition at line 72 of file faceZoneToFaceZone.C.

◆ faceZoneToFaceZone() [3/3]

faceZoneToFaceZone ( const polyMesh mesh,
Istream is 
)

Definition at line 83 of file faceZoneToFaceZone.C.

◆ ~faceZoneToFaceZone()

virtual ~faceZoneToFaceZone ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "faceZoneToFaceZone"  )

◆ applyToSet()

void applyToSet ( const topoSetSource::setAction  action,
topoSet set 
) const
virtual

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