faceZoneToFaceZone Class Reference

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

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

Public Member Functions

 TypeName ("faceZoneToFaceZone")
 Runtime type information. More...
 
 faceZoneToFaceZone (const polyMesh &mesh, const word &setName)
 Construct from components. More...
 
 faceZoneToFaceZone (const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
 faceZoneToFaceZone (const polyMesh &mesh, Istream &is)
 Construct from Istream. More...
 
virtual ~faceZoneToFaceZone ()=default
 Destructor. More...
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &set) const
 Apply specified action to the topoSet. More...
 
- 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)
 Construct from mesh. More...
 
 topoSetFaceZoneSource (const polyMesh &mesh, const dictionary &dict)
 
autoPtr< topoSetFaceZoneSourceclone () const
 Clone (disallowed) More...
 
virtual ~topoSetFaceZoneSource ()=default
 Destructor. More...
 
virtual topoSetSource::sourceType setType () const
 The source category is a faceZone. More...
 
- Public Member Functions inherited from topoSetSource
 TypeName ("topoSetSource")
 Runtime type information. More...
 
 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)
 Construct from mesh, with preferred verbosity. More...
 
 topoSetSource (const polyMesh &mesh, const dictionary &dict)
 Construct from mesh, use "verbose" entry if present. More...
 
autoPtr< topoSetSourceclone () const
 Clone (disallowed) More...
 
virtual ~topoSetSource ()=default
 Destructor. More...
 
const polyMeshmesh () const noexcept
 Reference to the mesh. More...
 
bool verbose () const noexcept
 Get output verbosity. More...
 
bool verbose (bool on) noexcept
 Enable/disable verbose output. More...
 
void verbose (const dictionary &dict)
 Use "verbose" entry (if present) to enable/disable verbose output. More...
 
virtual sourceType setType () const =0
 The source category (cell/face/point combined with set/zone) More...
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &set) const =0
 Apply specified action to the topoSet. More...
 

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
}
 Enumeration defining the types of sources. More...
 
enum  setAction {
  ADD , SUBTRACT , NEW , SUBSET ,
  INVERT , CLEAR , REMOVE , LIST ,
  IGNORE , DELETE = SUBTRACT
}
 Enumeration defining various actions. More...
 
- Static Public Member Functions inherited from topoSetFaceZoneSource
static autoPtr< topoSetFaceZoneSourceNew (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected source type. More...
 
static autoPtr< topoSetFaceZoneSourceNew (const word &sourceType, const polyMesh &mesh, Istream &is)
 Return a reference to the selected source type. More...
 
- Static Public Member Functions inherited from topoSetSource
static IstreamcheckIs (Istream &is)
 Check state of stream. More...
 
static bool isSetSource (const sourceType t) noexcept
 True if a "set" source. More...
 
static bool isZoneSource (const sourceType t) noexcept
 True if a "zone" source. More...
 
static bool isCell (const sourceType t) noexcept
 True if "cell" geometric type. More...
 
static bool isFace (const sourceType t) noexcept
 True if "face" geometric type. More...
 
static bool isPoint (const sourceType t) noexcept
 True if "point" geometric type. More...
 
static const stringusage (const word &name)
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected topoSetSource. More...
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
 Return a reference to the selected topoSetSource. More...
 
static setAction toAction (const word &actionName)
 Deprecated(2018-07) convert string to action. More...
 
- Static Public Attributes inherited from topoSetSource
static const Enum< setActionactionNames
 
static const Enum< setActioncombineNames
 
- Protected Member Functions inherited from topoSetSource
void addOrDelete (topoSet &set, const label id, const bool add) const
 Add or delete id from set. Add when 'add' is true. More...
 
void addOrDelete (topoSet &set, const labelUList &labels, const bool add) const
 Add or delete labels from set. Add when 'add' is true. More...
 
void addOrDelete (topoSet &set, const bitSet &labels, const bool add) const
 Add or delete labels from set. Add when 'add' is true. More...
 
 topoSetSource (const topoSetSource &)=delete
 No copy construct. More...
 
void operator= (const topoSetSource &)=delete
 No copy assignment. More...
 
- Static Protected Member Functions inherited from topoSetSource
static bool check (labelList &list, const label maxLabel)
 Detect and remove any values less than 0 or ge maxLabel. More...
 
- Protected Attributes inherited from topoSetSource
const polyMeshmesh_
 Reference to the mesh. More...
 
bool verbose_
 Output verbosity (default: true) More...
 
- Static Protected Attributes inherited from topoSetSource
static const string illegalSource_
 
static HashTable< string > * usageTablePtr_ = nullptr
 A table of usage strings. More...
 

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 146 of file faceZoneToFaceZone.H.

Constructor & Destructor Documentation

◆ faceZoneToFaceZone() [1/3]

faceZoneToFaceZone ( const polyMesh mesh,
const word setName 
)

Construct from components.

Definition at line 67 of file faceZoneToFaceZone.C.

◆ faceZoneToFaceZone() [2/3]

faceZoneToFaceZone ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 78 of file faceZoneToFaceZone.C.

◆ faceZoneToFaceZone() [3/3]

faceZoneToFaceZone ( const polyMesh mesh,
Istream is 
)

Construct from Istream.

Definition at line 89 of file faceZoneToFaceZone.C.

◆ ~faceZoneToFaceZone()

virtual ~faceZoneToFaceZone ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "faceZoneToFaceZone"  )

Runtime type information.

◆ applyToSet()

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

Apply specified action to the topoSet.

Implements topoSetSource.

Definition at line 102 of file faceZoneToFaceZone.C.

References topoSetSource::ADD, faceZoneSet::addressing(), DynamicList< T, SizeMin >::append(), Foam::endl(), faceZoneSet::flipMap(), forAll, topoSet::found(), Foam::Info, topoSetSource::NEW, UList< T >::size(), topoSetSource::SUBTRACT, List< T >::transfer(), faceZoneSet::updateSet(), and WarningInFunction.

Here is the call graph for this function:

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