topoSetSource Class Referenceabstract

Base class of a source for a topoSet. More...

Inheritance diagram for topoSetSource:
Collaboration diagram for topoSetSource:

Classes

class  iNew
 Class used for the read-construction of. More...
 

Public Types

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 ("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
 
virtual sourceType setType () const =0
 
virtual void applyToSet (const setAction action, topoSet &) const =0
 
void operator= (const topoSetSource &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

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

void addOrDelete (topoSet &set, const label celli, const bool) const
 Add (if bool) celli to set or delete celli from set. More...
 

Protected Attributes

const polyMeshmesh_
 

Detailed Description

Base class of a source for a topoSet.

Implementer has to modify the given set (see applyToSet) according to its function and the setAction (one of add/delete/new)

Source files

Definition at line 63 of file topoSetSource.H.

Member Enumeration Documentation

◆ sourceType

enum sourceType

Enumeration defining the types of sources.

Enumerator
CELLSETSOURCE 
FACESETSOURCE 
POINTSETSOURCE 
CELLZONESOURCE 
FACEZONESOURCE 
POINTZONESOURCE 

Definition at line 70 of file topoSetSource.H.

◆ setAction

enum setAction

Enumeration defining the valid actions.

Enumerator
CLEAR 
NEW 
INVERT 
ADD 
DELETE 
SUBSET 
LIST 
REMOVE 

Definition at line 82 of file topoSetSource.H.

Constructor & Destructor Documentation

◆ topoSetSource() [1/2]

topoSetSource ( const polyMesh mesh)

Construct from components.

Definition at line 115 of file topoSetSource.C.

◆ topoSetSource() [2/2]

topoSetSource ( const topoSetSource )
delete

Disallow default bitwise copy construction.

◆ ~topoSetSource()

~topoSetSource ( )
virtual

Destructor.

Definition at line 123 of file topoSetSource.C.

Member Function Documentation

◆ addOrDelete()

void addOrDelete ( topoSet set,
const label  celli,
const bool  add 
) const
protected

Add (if bool) celli to set or delete celli from set.

Definition at line 95 of file topoSetSource.C.

References Foam::add(), HashTable< T, Key, Hash >::erase(), and HashSet< Key, Hash >::insert().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "topoSetSource"  )

Runtime type information.

◆ toAction()

static setAction toAction ( const word actionName)
inlinestatic

Convert string to action.

Definition at line 121 of file topoSetSource.H.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
topoSetSource  ,
word  ,
(const polyMesh &mesh, const dictionary &dict ,
(mesh, dict  
)

◆ clone()

autoPtr<topoSetSource> clone ( ) const
inline

Clone.

Definition at line 174 of file topoSetSource.H.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::topoSetSource > New ( const word topoSetSourceType,
const polyMesh mesh,
const dictionary dict 
)
static

Return a reference to the selected topoSetSource.

Definition at line 69 of file topoSetSource.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and topoSetSource::mesh().

Referenced by topoSetSource::iNew::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ mesh()

const polyMesh& mesh ( ) const
inline

Definition at line 198 of file topoSetSource.H.

References topoSetSource::mesh_.

Referenced by topoSetSource::New().

Here is the caller graph for this function:

◆ setType()

◆ applyToSet()

◆ operator=()

void operator= ( const topoSetSource )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ mesh_

const polyMesh& mesh_
protected

Definition at line 99 of file topoSetSource.H.

Referenced by topoSetSource::mesh().


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