cellToFace Class Reference

A topoSetFaceSource to select all the faces from given cellSet(s). More...

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

Public Types

enum  cellAction { ALL , BOTH }
 Enumeration defining the valid options. More...
 
- 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...
 

Public Member Functions

 TypeName ("cellToFace")
 Runtime type information. More...
 
 cellToFace (const polyMesh &mesh, const word &setName, const cellAction option)
 Construct from components. More...
 
 cellToFace (const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
 cellToFace (const polyMesh &mesh, Istream &is)
 Construct from Istream. More...
 
virtual ~cellToFace ()=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 topoSetFaceSource
 declareRunTimeSelectionTable (autoPtr, topoSetFaceSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
 
 declareRunTimeSelectionTable (autoPtr, topoSetFaceSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
 
 topoSetFaceSource (const polyMesh &mesh)
 Construct from mesh. More...
 
 topoSetFaceSource (const polyMesh &mesh, const dictionary &dict)
 Construct from mesh, use "verbose" entry if present. More...
 
autoPtr< topoSetFaceSourceclone () const
 Clone (disallowed) More...
 
virtual ~topoSetFaceSource ()=default
 Destructor. More...
 
virtual topoSetSource::sourceType setType () const
 The source category is a faceSet. 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

- Static Public Member Functions inherited from topoSetFaceSource
static autoPtr< topoSetFaceSourceNew (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected source type. More...
 
static autoPtr< topoSetFaceSourceNew (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 topoSetFaceSource to select all the faces from given cellSet(s).

Operands:

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

    // Mandatory entries
    source      cellToFace;
    option      <option>;

    // Conditional mandatory entries
    // Select either of the below

    // Option-1
    sets
    (
        <cellSetName1>
        <cellSetName2>
        ...
    );

    // Option-2
    set <cellSetName>;
}

where the entries mean:

Property Description Type Req'd Dflt
name Name of faceSet word yes -
type Type name: faceSet word yes -
action Action applied on faces - see below word yes -
source Source name: cellToFace word yes -
option Selection type - see below word yes -

Options for the action entry:

      new      | Create a new faceSet from selected cells of cellSet(s)
      add      | Add selected faces of cellSet(s) into this faceSet
      subtract | Remove selected faces of cellSet(s) from this faceSet

Options for the option entry:

      all     | All faces of cells in the cellSet
      both    | Faces where both neighbours are in the cellSet

Options for the conditional mandatory entries:

      Entry    | Description                    | Type     | Req'd  | Dflt
      sets     | Names of input cellSets        | wordList | cond'l | -
      set      | Name of input cellSet          | word     | cond'l | -
Note
The order of precedence among the conditional mandatory entries from the highest to the lowest is sets, and set.
See also
Source files

Definition at line 174 of file cellToFace.H.

Member Enumeration Documentation

◆ cellAction

enum cellAction

Enumeration defining the valid options.

Enumerator
ALL 
BOTH 

Definition at line 180 of file cellToFace.H.

Constructor & Destructor Documentation

◆ cellToFace() [1/3]

cellToFace ( const polyMesh mesh,
const word setName,
const cellAction  option 
)

Construct from components.

Definition at line 156 of file cellToFace.C.

◆ cellToFace() [2/3]

cellToFace ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 169 of file cellToFace.C.

References dict, UList< T >::first(), dictionary::readEntry(), dictionary::readIfPresent(), and List< T >::resize().

Here is the call graph for this function:

◆ cellToFace() [3/3]

cellToFace ( const polyMesh mesh,
Istream is 
)

Construct from Istream.

Definition at line 188 of file cellToFace.C.

◆ ~cellToFace()

virtual ~cellToFace ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "cellToFace"  )

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 202 of file cellToFace.C.

References topoSetSource::ADD, Foam::flatOutput(), Foam::Info, topoSetSource::NEW, Foam::nl, and topoSetSource::SUBTRACT.

Here is the call graph for this function:

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