Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
topoSetSource Class Referenceabstract

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

Inherited by badQualityToCell, badQualityToFace, boundaryToFace, boxToCell, boxToFace, boxToPoint, cellToCell, cellToFace, cellToPoint, cylinderAnnulusToCell, cylinderAnnulusToFace, cylinderToCell, cylinderToFace, faceToCell, faceToFace, faceToPoint, faceZoneToCell, faceZoneToFaceZone, fieldToCell, labelToCell, labelToFace, labelToPoint, nbrToCell, nearestToCell, nearestToPoint, normalToFace, patchDistanceToCell, patchFluxToFace, patchToFace, planeToFaceZone, pointToCell, pointToFace, pointToPoint, regionToCell, regionToFace, rotatedBoxToCell, rotatedBoxToFace, searchableSurfaceToFaceZone, setAndNormalToFaceZone, setsToFaceZone, setToCellZone, setToFaceZone, setToPointZone, shapeToCell, sphereToCell, surfaceToCell, surfaceToPoint, targetVolumeToCell, zoneToCell, zoneToFace, and zoneToPoint.

Collaboration diagram for topoSetSource:
Collaboration graph
[legend]

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< topoSetSource > clone () const
 Clone. More...
 
virtual ~topoSetSource ()
 Destructor. More...
 
const polyMesh & mesh () 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< topoSetSource > New (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 polyMesh & mesh_
 

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.

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

Here is the caller graph for this function:

◆ topoSetSource() [2/2]

topoSetSource ( const topoSetSource &  )
delete

Disallow default bitwise copy construction.

◆ ~topoSetSource()

~topoSetSource ( )
virtual

Destructor.

Definition at line 123 of file topoSetSource.C.

Referenced by topoSetSource::clone().

Here is the caller graph for this function:

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 96 of file topoSetSource.C.

Referenced by topoSetSource::New().

Here is the caller 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.

References topoSetSource::declareRunTimeSelectionTable(), dict, and topoSetSource::mesh().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable()

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

Referenced by topoSetSource::toAction().

Here is the caller graph for this function:

◆ clone()

autoPtr<topoSetSource> clone ( ) const
inline

Clone.

Definition at line 174 of file topoSetSource.H.

References topoSetSource::New(), NotImplemented, and topoSetSource::~topoSetSource().

Here is the call graph for this function:

◆ 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 70 of file topoSetSource.C.

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

Referenced by topoSetSource::clone(), NamedEnum< compressibleField, 8 >::names(), and 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::applyToSet(), topoSetSource::operator=(), and topoSetSource::setType().

Referenced by topoSetSource::toAction().

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

◆ setType()

virtual sourceType setType ( ) const
pure virtual

Implemented in surfaceToCell, regionToCell, patchFluxToFace, rotatedBoxToCell, rotatedBoxToFace, planeToFaceZone, surfaceToPoint, cellToFace, faceToCell, pointToFace, targetVolumeToCell, faceZoneToCell, pointToCell, cellToPoint, faceToPoint, fieldToCell, cylinderAnnulusToCell, cylinderAnnulusToFace, regionToFace, cylinderToCell, shapeToCell, cylinderToFace, sphereToCell, normalToFace, setsToFaceZone, nbrToCell, zoneToCell, patchToFace, zoneToFace, boxToPoint, zoneToPoint, boxToCell, labelToCell, nearestToCell, boxToFace, labelToFace, labelToPoint, nearestToPoint, searchableSurfaceToFaceZone, setAndNormalToFaceZone, patchDistanceToCell, setToFaceZone, badQualityToCell, badQualityToFace, cellToCell, setToCellZone, faceToFace, faceZoneToFaceZone, pointToPoint, setToPointZone, and boundaryToFace.

Referenced by topoSetSource::mesh().

Here is the caller graph for this function:

◆ applyToSet()

virtual void applyToSet ( const setAction  action,
topoSet &   
) const
pure virtual

Implemented in surfaceToCell, regionToCell, patchFluxToFace, rotatedBoxToCell, rotatedBoxToFace, planeToFaceZone, surfaceToPoint, cellToFace, faceToCell, pointToFace, targetVolumeToCell, faceZoneToCell, pointToCell, cellToPoint, faceToPoint, fieldToCell, cylinderAnnulusToCell, cylinderAnnulusToFace, regionToFace, cylinderToCell, shapeToCell, cylinderToFace, sphereToCell, normalToFace, setsToFaceZone, nbrToCell, zoneToCell, patchToFace, zoneToFace, boxToPoint, zoneToPoint, boxToCell, labelToCell, nearestToCell, boxToFace, labelToFace, labelToPoint, nearestToPoint, searchableSurfaceToFaceZone, setAndNormalToFaceZone, patchDistanceToCell, setToFaceZone, badQualityToCell, badQualityToFace, cellToCell, setToCellZone, faceToFace, faceZoneToFaceZone, pointToPoint, setToPointZone, and boundaryToFace.

Referenced by topoSetSource::mesh().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const topoSetSource &  )
delete

Disallow default bitwise assignment.

Referenced by topoSetSource::mesh().

Here is the caller graph for this function:

Member Data Documentation

◆ mesh_

const polyMesh& mesh_
protected

Definition at line 99 of file topoSetSource.H.

Referenced by normalToFace::applyToSet().

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