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

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

Inheritance diagram for topoSetSource:
Inheritance graph
[legend]
Collaboration diagram for topoSetSource:
Collaboration graph
[legend]

Classes

class  addToUsageTable
 
class  iNew
 

Public Types

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
}
 
enum  setAction {
  ADD, NEW, SUBTRACT, SUBSET,
  INVERT, CLEAR, REMOVE, LIST,
  DELETE = SUBTRACT
}
 

Public Member Functions

 TypeName ("topoSetSource")
 
 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)
 
 topoSetSource (const polyMesh &mesh, const dictionary &dict)
 
autoPtr< topoSetSource > clone () const
 
virtual ~topoSetSource ()=default
 
const polyMesh & mesh () const noexcept
 
bool verbose () const noexcept
 
bool verbose (bool on) noexcept
 
void verbose (const dictionary &dict)
 
virtual sourceType setType () const =0
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &set) const =0
 

Static Public Member Functions

static Istream & checkIs (Istream &is)
 
static bool isSetSource (const sourceType t) noexcept
 
static bool isZoneSource (const sourceType t) noexcept
 
static bool isCell (const sourceType t) noexcept
 
static bool isFace (const sourceType t) noexcept
 
static bool isPoint (const sourceType t) noexcept
 
static const string & usage (const word &name)
 
static autoPtr< topoSetSource > New (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
 
static autoPtr< topoSetSource > New (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
 
static setAction toAction (const word &actionName)
 

Static Public Attributes

static const Enum< setAction > actionNames
 

Protected Member Functions

void addOrDelete (topoSet &set, const label id, const bool add) const
 
void addOrDelete (topoSet &set, const labelUList &labels, const bool add) const
 
void addOrDelete (topoSet &set, const bitSet &labels, const bool add) const
 
 topoSetSource (const topoSetSource &)=delete
 
void operator= (const topoSetSource &)=delete
 

Static Protected Member Functions

static bool check (labelList &list, const label maxLabel)
 

Protected Attributes

const polyMesh & mesh_
 
bool verbose_
 

Static Protected Attributes

static const string illegalSource_
 
static HashTable< string > * usageTablePtr_ = nullptr
 

Detailed Description

Base class of a source for a topoSet.

Implementer must 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
Enumerator
UNKNOWN_SOURCE 

Placeholder.

CELL_TYPE 

Geometric type is "cell".

FACE_TYPE 

Geometric type is "face".

POINT_TYPE 

Geometric type is "point".

SET_SOURCE 

A source based on topoSet.

CELLSET_SOURCE 

Cells as set.

FACESET_SOURCE 

Faces as set.

POINTSET_SOURCE 

Points as set.

ZONE_SOURCE 

A source based on mesh zone.

CELLZONE_SOURCE 

Cells as zone.

FACEZONE_SOURCE 

Faces as zone.

POINTZONE_SOURCE 

Points as zone.

CELLSETSOURCE 
FACESETSOURCE 
POINTSETSOURCE 
CELLZONESOURCE 
FACEZONESOURCE 
POINTZONESOURCE 

Definition at line 70 of file topoSetSource.H.

◆ setAction

enum setAction
Enumerator
ADD 

Add elements to current set.

NEW 

Create a new set and ADD elements to it.

SUBTRACT 

Subtract elements from current set.

SUBSET 

Union of elements with current set.

INVERT 

Invert the elements in the current set.

CLEAR 

Clear the set, possibly creating it.

REMOVE 

Remove the set (from the file system)

LIST 

Print contents of the set.

DELETE 
Deprecated:
(2018-10) Alias for SUBTRACT

Definition at line 96 of file topoSetSource.H.

Constructor & Destructor Documentation

◆ topoSetSource() [1/3]

topoSetSource ( const topoSetSource &  )
protecteddelete

◆ topoSetSource() [2/3]

topoSetSource ( const polyMesh &  mesh,
bool  verbose = true 
)
explicit

Definition at line 226 of file topoSetSource.C.

◆ topoSetSource() [3/3]

topoSetSource ( const polyMesh &  mesh,
const dictionary &  dict 
)

Definition at line 237 of file topoSetSource.C.

References dict.

◆ ~topoSetSource()

virtual ~topoSetSource ( )
virtualdefault

Member Function Documentation

◆ check()

bool check ( labelList &  list,
const label  maxLabel 
)
staticprotected

Definition at line 67 of file topoSetSource.C.

References List::resize().

Here is the call graph for this function:

◆ addOrDelete() [1/3]

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

Definition at line 164 of file topoSetSource.C.

References Foam::add(), and Foam::BitOps::set().

Here is the call graph for this function:

◆ addOrDelete() [2/3]

void addOrDelete ( topoSet &  set,
const labelUList &  labels,
const bool  add 
) const
protected

Definition at line 182 of file topoSetSource.C.

References Foam::add(), and Foam::BitOps::set().

Here is the call graph for this function:

◆ addOrDelete() [3/3]

void addOrDelete ( topoSet &  set,
const bitSet &  labels,
const bool  add 
) const
protected

Definition at line 200 of file topoSetSource.C.

References Foam::add(), and Foam::BitOps::set().

Here is the call graph for this function:

◆ operator=()

void operator= ( const topoSetSource &  )
protecteddelete

◆ TypeName()

TypeName ( "topoSetSource"  )

◆ checkIs()

Foam::Istream & checkIs ( Istream &  is)
static

Definition at line 149 of file topoSetSource.C.

References IOstream::eof(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and IOstream::good().

Here is the call graph for this function:

◆ isSetSource()

static bool isSetSource ( const sourceType  t)
inlinestaticnoexcept

Definition at line 203 of file topoSetSource.H.

References topoSetSource::SET_SOURCE.

◆ isZoneSource()

static bool isZoneSource ( const sourceType  t)
inlinestaticnoexcept

Definition at line 209 of file topoSetSource.H.

References topoSetSource::ZONE_SOURCE.

◆ isCell()

static bool isCell ( const sourceType  t)
inlinestaticnoexcept

Definition at line 215 of file topoSetSource.H.

References topoSetSource::CELL_TYPE.

◆ isFace()

static bool isFace ( const sourceType  t)
inlinestaticnoexcept

Definition at line 221 of file topoSetSource.H.

References topoSetSource::FACE_TYPE.

◆ isPoint()

static bool isPoint ( const sourceType  t)
inlinestaticnoexcept

Definition at line 227 of file topoSetSource.H.

References topoSetSource::POINT_TYPE.

◆ declareRunTimeSelectionTable() [1/2]

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

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
topoSetSource  ,
istream  ,
(const polyMesh &mesh, Istream &is)  ,
(mesh, is)   
)

◆ usage()

static const string& usage ( const word &  name)
inlinestatic

Definition at line 284 of file topoSetSource.H.

References topoSetSource::illegalSource_, Foam::name(), and topoSetSource::usageTablePtr_.

Here is the call graph for this function:

◆ clone()

autoPtr<topoSetSource> clone ( ) const
inline

Definition at line 305 of file topoSetSource.H.

References NotImplemented.

◆ New() [1/2]

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

Definition at line 103 of file topoSetSource.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and mesh.

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

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

◆ New() [2/2]

Foam::autoPtr< Foam::topoSetSource > New ( const word &  topoSetSourceType,
const polyMesh &  mesh,
Istream &  is 
)
static

Definition at line 127 of file topoSetSource.C.

References Foam::exit(), Foam::FatalError, FatalErrorInLookup, and mesh.

Here is the call graph for this function:

◆ mesh()

const polyMesh& mesh ( ) const
inlinenoexcept

Definition at line 338 of file topoSetSource.H.

References topoSetSource::mesh_.

◆ verbose() [1/3]

bool verbose ( ) const
inlinenoexcept

Definition at line 344 of file topoSetSource.H.

References topoSetSource::verbose_.

◆ verbose() [2/3]

bool verbose ( bool  on)
inlinenoexcept

Definition at line 351 of file topoSetSource.H.

References topoSetSource::verbose_.

◆ verbose() [3/3]

void verbose ( const dictionary &  dict)

Definition at line 250 of file topoSetSource.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ setType()

virtual sourceType setType ( ) const
pure virtual

Implemented in topoSetCellZoneSource, topoSetFaceZoneSource, topoSetPointZoneSource, topoSetCellSource, topoSetFaceSource, and topoSetPointSource.

◆ applyToSet()

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

Implemented in faceZoneToCell, surfaceToPoint, regionToCell, faceToCell, pointToFace, pointToCell, zoneToFace, zoneToCell, faceToPoint, zoneToPoint, cellToPoint, cylinderAnnulusToCell, rotatedBoxToCell, cylinderToCell, targetVolumeToCell, cylinderToFace, cylinderToPoint, fieldToCell, setsToFaceZone, searchableSurfaceToFaceZone, boxToCell, searchableSurfaceToCell, boxToFace, searchableSurfaceToFace, boxToPoint, searchableSurfaceToPoint, sphereToCell, sphereToFace, sphereToPoint, shapeToCell, normalToFace, patchToFace, haloToCell, cellToCell, patchToCell, faceToFace, pointToPoint, setToFaceZone, setAndNormalToFaceZone, setToPointZone, nearestToCell, nearestToPoint, setToCellZone, labelToCell, labelToFace, faceZoneToFaceZone, labelToPoint, nbrToCell, boundaryToCell, boundaryToFace, regionsToCell, badQualityToFace, badQualityToCell, surfaceToCell, planeToFaceZone, cylinderAnnulusToFace, and regionToFace.

◆ toAction()

static setAction toAction ( const word &  actionName)
inlinestatic

Definition at line 379 of file topoSetSource.H.

References topoSetSource::actionNames.

Member Data Documentation

◆ actionNames

const Foam::Enum< Foam::topoSetSource::setAction > actionNames
static

Definition at line 114 of file topoSetSource.H.

Referenced by topoSetSource::toAction().

◆ illegalSource_

const Foam::string illegalSource_
staticprotected

Definition at line 119 of file topoSetSource.H.

Referenced by topoSetSource::usage().

◆ usageTablePtr_

Foam::HashTable< Foam::string > * usageTablePtr_ = nullptr
staticprotected

Definition at line 122 of file topoSetSource.H.

Referenced by topoSetSource::addToUsageTable::addToUsageTable(), topoSetSource::usage(), and topoSetSource::addToUsageTable::~addToUsageTable().

◆ mesh_

const polyMesh& mesh_
protected

Definition at line 152 of file topoSetSource.H.

Referenced by topoSetSource::mesh().

◆ verbose_

bool verbose_
protected

Definition at line 155 of file topoSetSource.H.

Referenced by topoSetSource::verbose().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17