faceToCell Class Reference

A topoSetSource to select cells based on usage in faces. More...

Inheritance diagram for faceToCell:
Collaboration diagram for faceToCell:

Public Types

enum  faceAction { NEIGHBOUR , OWNER , ANY , ALL }
 Enumeration defining the valid options. More...
 
- Public Types inherited from topoSetSource
enum  sourceType {
  CELLSETSOURCE , FACESETSOURCE , POINTSETSOURCE , CELLZONESOURCE ,
  FACEZONESOURCE , POINTZONESOURCE
}
 Enumeration defining the types of sources. More...
 
enum  setAction {
  CLEAR , NEW , INVERT , ADD ,
  DELETE , SUBSET , LIST , REMOVE
}
 Enumeration defining the valid actions. More...
 

Public Member Functions

 TypeName ("faceToCell")
 Runtime type information. More...
 
 faceToCell (const polyMesh &mesh, const word &setName, const faceAction option)
 Construct from components. More...
 
 faceToCell (const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~faceToCell ()
 Destructor. More...
 
virtual sourceType setType () const
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &) const
 
- Public Member Functions inherited from topoSetSource
 TypeName ("topoSetSource")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, topoSetSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
 
 topoSetSource (const polyMesh &mesh)
 Construct from components. More...
 
 topoSetSource (const topoSetSource &)=delete
 Disallow default bitwise copy construction. More...
 
autoPtr< topoSetSourceclone () const
 Clone. More...
 
virtual ~topoSetSource ()
 Destructor. More...
 
const polyMeshmesh () const
 
void operator= (const topoSetSource &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Attributes

static const NamedEnum< faceAction, 4 > faceActionNames_
 Names of the valid options. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from topoSetSource
static setAction toAction (const word &actionName)
 Convert string to action. More...
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected topoSetSource. More...
 
- Protected Member Functions inherited from topoSetSource
void addOrDelete (topoSet &set, const label celli, const bool) const
 Add (if bool) celli to set or delete celli from set. More...
 
- Protected Attributes inherited from topoSetSource
const polyMeshmesh_
 

Detailed Description

A topoSetSource to select cells based on usage in faces.

Source files

Definition at line 49 of file faceToCell.H.

Member Enumeration Documentation

◆ faceAction

enum faceAction

Enumeration defining the valid options.

Enumerator
NEIGHBOUR 
OWNER 
ANY 
ALL 

Definition at line 58 of file faceToCell.H.

Constructor & Destructor Documentation

◆ faceToCell() [1/2]

faceToCell ( const polyMesh mesh,
const word setName,
const faceAction  option 
)

Construct from components.

Definition at line 145 of file faceToCell.C.

◆ faceToCell() [2/2]

faceToCell ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 158 of file faceToCell.C.

◆ ~faceToCell()

~faceToCell ( )
virtual

Destructor.

Definition at line 172 of file faceToCell.C.

Member Function Documentation

◆ TypeName()

TypeName ( "faceToCell"  )

Runtime type information.

◆ setType()

virtual sourceType setType ( ) const
inlinevirtual

Implements topoSetSource.

Definition at line 117 of file faceToCell.H.

References topoSetSource::CELLSETSOURCE.

◆ applyToSet()

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

Implements topoSetSource.

Definition at line 178 of file faceToCell.C.

References topoSetSource::ADD, Foam::combine(), topoSetSource::DELETE, Foam::endl(), Foam::Info, and topoSetSource::NEW.

Here is the call graph for this function:

Member Data Documentation

◆ faceActionNames_

const Foam::NamedEnum< Foam::faceToCell::faceAction, 4 > faceActionNames_
static

Names of the valid options.

Definition at line 67 of file faceToCell.H.


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