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

Inheritance diagram for topoSetSource:

Collaboration diagram for topoSetSource:

Classes
class	addToUsageTable
	Class with constructor to add usage string to table. More...

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

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 }
	Enumeration defining the types of sources. More...

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

	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< topoSetSource >	clone () const
	Clone (disallowed) More...

virtual	~topoSetSource ()=default
	Destructor. More...

const polyMesh &	mesh () 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...

Static Public Member Functions
static Istream &	checkIs (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 string &	usage (const word &name)

static autoPtr< topoSetSource >	New (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected topoSetSource. More...

static autoPtr< topoSetSource >	New (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
static const Enum< setAction >	actionNames
	The setActions text representations. More...

Protected Member Functions
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
static bool	check (labelList &list, const label maxLabel)
	Detect and remove any values less than 0 or ge maxLabel. More...

Protected Attributes
const polyMesh &	mesh_
	Reference to the mesh. More...

bool	verbose_
	Output verbosity (default: true) More...

Static Protected Attributes
static const string	illegalSource_

static HashTable< string > *	usageTablePtr_ = nullptr
	A table of usage strings. More...

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 67 of file topoSetSource.H.

Member Enumeration Documentation

◆ sourceType

enum sourceType

Enumeration defining the types of sources.

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 74 of file topoSetSource.H.

◆ setAction

enum setAction

Enumeration defining the valid actions.

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 100 of file topoSetSource.H.

Constructor & Destructor Documentation

◆ topoSetSource() [1/3]

topoSetSource ( const topoSetSource & )

protecteddelete

No copy construct.

◆ topoSetSource() [2/3]

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

explicit

Construct from mesh, with preferred verbosity.

Definition at line 233 of file topoSetSource.C.

◆ topoSetSource() [3/3]

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

Construct from mesh, use "verbose" entry if present.

Definition at line 244 of file topoSetSource.C.

References dict.

◆ ~topoSetSource()

virtual ~topoSetSource ( )

virtualdefault

Destructor.

Member Function Documentation

◆ check()

bool check	(	labelList &	list,
		const label	maxLabel
	)

staticprotected

Detect and remove any values less than 0 or ge maxLabel.

Returns: false if invalid elements were detected (and removed)

Definition at line 74 of file topoSetSource.C.

References List< T >::resize().

Here is the call graph for this function:

◆ addOrDelete() [1/3]

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

protected

Add or delete id from set. Add when 'add' is true.

Definition at line 171 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

Add or delete labels from set. Add when 'add' is true.

Definition at line 189 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

Add or delete labels from set. Add when 'add' is true.

Definition at line 207 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

No copy assignment.

◆ TypeName()

TypeName ( "topoSetSource" )

Runtime type information.

◆ checkIs()

Foam::Istream & checkIs ( Istream & is )

static

Check state of stream.

Definition at line 156 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

True if a "set" source.

Definition at line 207 of file topoSetSource.H.

References topoSetSource::SET_SOURCE.

◆ isZoneSource()

static bool isZoneSource ( const sourceType t )

inlinestaticnoexcept

True if a "zone" source.

Definition at line 213 of file topoSetSource.H.

References topoSetSource::ZONE_SOURCE.

◆ isCell()

static bool isCell ( const sourceType t )

inlinestaticnoexcept

True if "cell" geometric type.

Definition at line 219 of file topoSetSource.H.

References topoSetSource::CELL_TYPE.

◆ isFace()

static bool isFace ( const sourceType t )

inlinestaticnoexcept

True if "face" geometric type.

Definition at line 225 of file topoSetSource.H.

References topoSetSource::FACE_TYPE.

◆ isPoint()

static bool isPoint ( const sourceType t )

inlinestaticnoexcept

True if "point" geometric type.

Definition at line 231 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 288 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

Clone (disallowed)

Definition at line 309 of file topoSetSource.H.

References NotImplemented.

◆ New() [1/2]

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 110 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

Return a reference to the selected topoSetSource.

Definition at line 134 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

Reference to the mesh.

Definition at line 342 of file topoSetSource.H.

References topoSetSource::mesh_.

◆ verbose() [1/3]

bool verbose ( ) const

inlinenoexcept

Get output verbosity.

Definition at line 348 of file topoSetSource.H.

References topoSetSource::verbose_.

◆ verbose() [2/3]

bool verbose ( bool on )

inlinenoexcept

Enable/disable verbose output.

Returns: old value

Definition at line 355 of file topoSetSource.H.

◆ verbose() [3/3]

void verbose ( const dictionary & dict )

Use "verbose" entry (if present) to enable/disable verbose output.

Definition at line 257 of file topoSetSource.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ setType()

virtual sourceType setType ( ) const

pure virtual

The source category (cell/face/point combined with set/zone)

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

◆ applyToSet()

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

pure virtual

Apply specified action to the topoSet.

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

Deprecated(2018-07) convert string to action.

Deprecated:: (2018-07) - use actionNames[] directly

Definition at line 383 of file topoSetSource.H.

Member Data Documentation

◆ actionNames

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

static

The setActions text representations.

Definition at line 118 of file topoSetSource.H.

◆ illegalSource_

const Foam::string illegalSource_

staticprotected

Definition at line 123 of file topoSetSource.H.

Referenced by topoSetSource::usage().

◆ usageTablePtr_

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

staticprotected

A table of usage strings.

Definition at line 126 of file topoSetSource.H.

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

◆ mesh_

const polyMesh& mesh_

protected

Reference to the mesh.

Definition at line 156 of file topoSetSource.H.

Referenced by topoSetSource::mesh().

◆ verbose_

bool verbose_

protected

Output verbosity (default: true)

Definition at line 159 of file topoSetSource.H.

Referenced by topoSetSource::verbose().

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

src/meshTools/sets/topoSetSource/topoSetSource.H
src/meshTools/sets/topoSetSource/topoSetSource.C

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

Detailed Description

Member Enumeration Documentation

◆ sourceType

◆ setAction

Constructor & Destructor Documentation

◆ topoSetSource() [1/3]

◆ topoSetSource() [2/3]

◆ topoSetSource() [3/3]

◆ ~topoSetSource()

Member Function Documentation

◆ check()

◆ addOrDelete() [1/3]

◆ addOrDelete() [2/3]

◆ addOrDelete() [3/3]

◆ operator=()

◆ TypeName()

◆ checkIs()

◆ isSetSource()

◆ isZoneSource()

◆ isCell()

◆ isFace()

◆ isPoint()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ usage()

◆ clone()

◆ New() [1/2]

◆ New() [2/2]

◆ mesh()

◆ verbose() [1/3]

◆ verbose() [2/3]

◆ verbose() [3/3]

◆ setType()

◆ applyToSet()

◆ toAction()

Member Data Documentation

◆ actionNames

◆ illegalSource_

◆ usageTablePtr_

◆ mesh_

◆ verbose_