The topoSetCellZoneSource is a intermediate class for handling topoSet sources for selecting cell zones. More...

#include <topoSetCellZoneSource.H>

Inheritance diagram for topoSetCellZoneSource:

[legend]

Collaboration diagram for topoSetCellZoneSource:

Public Member Functions
	declareRunTimeSelectionTable (autoPtr, topoSetCellZoneSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
	declareRunTimeSelectionTable (autoPtr, topoSetCellZoneSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
	topoSetCellZoneSource (const polyMesh &mesh)
	Construct from mesh.
	topoSetCellZoneSource (const polyMesh &mesh, const dictionary &dict)
	Construct from mesh, use "verbose" entry if present.
autoPtr< topoSetCellZoneSource >	clone () const
	Clone (disallowed).
virtual	~topoSetCellZoneSource ()=default
	Destructor.
virtual topoSetSource::sourceType	setType () const
	The source category is a cellZone.
Public Member Functions inherited from topoSetSource
	TypeName ("topoSetSource")
	Runtime type information.
	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.
	topoSetSource (const polyMesh &mesh, const dictionary &dict)
	Construct from mesh, use "verbose" entry if present.
autoPtr< topoSetSource >	clone () const
	Clone (disallowed).
virtual	~topoSetSource ()=default
	Destructor.
const polyMesh &	mesh () const noexcept
	Reference to the mesh.
bool	verbose () const noexcept
	Get output verbosity.
bool	verbose (bool on) noexcept
	Enable/disable verbose output.
void	verbose (const dictionary &dict)
	Use "verbose" entry (if present) to enable/disable verbose output.
virtual void	applyToSet (const topoSetSource::setAction action, topoSet &set) const =0
	Apply specified action to the topoSet.
bool	hasTransform () const noexcept
	True if coordinate transform is active.
tmp< pointField >	transform (const pointField &points) const
	Coordinate transform (optionally) coordinates. Returns reference to input data if no transform is active.

Static Public Member Functions
static autoPtr< topoSetCellZoneSource >	New (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected source type.
static autoPtr< topoSetCellZoneSource >	New (const word &sourceType, const polyMesh &mesh, Istream &is)
	Return a reference to the selected source type.
Static Public Member Functions inherited from topoSetSource
static Istream &	checkIs (Istream &is)
	Check state of stream.
static bool	isSetSource (const sourceType t) noexcept
	True if a "set" source.
static bool	isZoneSource (const sourceType t) noexcept
	True if a "zone" source.
static bool	isCell (const sourceType t) noexcept
	True if "cell" geometric type.
static bool	isFace (const sourceType t) noexcept
	True if "face" geometric type.
static bool	isPoint (const sourceType t) noexcept
	True if "point" geometric type.
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.
static autoPtr< topoSetSource >	New (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
	Return a reference to the selected topoSetSource.
static setAction	toAction (const word &actionName)
	Deprecated(2018-07) convert string to action.
static bool	readNames (const dictionary &dict, wordList &names)
	Helper: extract wordList of patches/zones from dictionary. Returns.

Additional Inherited Members
Public Types inherited from topoSetSource
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 , SUBTRACT , NEW , SUBSET , INVERT , CLEAR , REMOVE , LIST , IGNORE , DELETE = SUBTRACT }
	Enumeration defining various actions. More...
Static Public Attributes inherited from topoSetSource
static const Enum< setAction >	actionNames
	The setActions enum text. Names: "new", add", "subtract", "subset", "invert", "clear", "remove", "list", "ignore".
static const Enum< setAction >	combineNames
	The setAction enum text when combining selections. Names: "use", "add", "subtract", "subset", "invert", "ignore".
Protected Member Functions inherited from topoSetSource
void	addOrDelete (topoSet &set, const label id, const bool add) const
	Add or delete id from set. Add when 'add' is true.
void	addOrDelete (topoSet &set, const labelUList &labels, const bool add) const
	Add or delete labels from set. Add when 'add' is true.
void	addOrDelete (topoSet &set, const bitSet &labels, const bool add) const
	Add or delete labels from set. Add when 'add' is true.
	topoSetSource (const topoSetSource &)=delete
	No copy construct.
void	operator= (const topoSetSource &)=delete
	No copy assignment.
Static Protected Member Functions inherited from topoSetSource
static bool	check (labelList &list, const label maxLabel)
	Detect and remove any values less than 0 or ge maxLabel.
Protected Attributes inherited from topoSetSource
const polyMesh &	mesh_
	Reference to the mesh.
bool	verbose_
	Output verbosity (default: true).
autoPtr< solidBodyMotionFunction >	transformPtr_
	Optional transformation for geometric data.
Static Protected Attributes inherited from topoSetSource
static const string	illegalSource_
static HashTable< string > *	usageTablePtr_ = nullptr
	A table of usage strings.

Detailed Description

The topoSetCellZoneSource is a intermediate class for handling topoSet sources for selecting cell zones.

The class is not an executable topoSet itself, yet a provider for common entries to its derived topoSet.

Source files

Definition at line 53 of file topoSetCellZoneSource.H.

Constructor & Destructor Documentation

◆ topoSetCellZoneSource() [1/2]

topoSetCellZoneSource ( const polyMesh & mesh )

explicit

Construct from mesh.

Definition at line 35 of file topoSetCellZoneSource.C.

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

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), setToCellZone::setToCellZone(), setToCellZone::setToCellZone(), and setToCellZone::setToCellZone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ topoSetCellZoneSource() [2/2]

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

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

Definition at line 41 of file topoSetCellZoneSource.C.

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

Here is the call graph for this function:

◆ ~topoSetCellZoneSource()

virtual ~topoSetCellZoneSource ( )

virtualdefault

Destructor.

Member Function Documentation

◆ declareRunTimeSelectionTable() [1/2]

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

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

Here is the call graph for this function:

◆ declareRunTimeSelectionTable() [2/2]

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

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

Here is the call graph for this function:

◆ clone()

autoPtr< topoSetCellZoneSource > clone ( ) const

inline

Clone (disallowed).

Definition at line 104 of file topoSetCellZoneSource.H.

References NotImplemented.

◆ New() [1/2]

Foam::autoPtr< Foam::topoSetCellZoneSource > New	(	const word &	sourceType,
		const polyMesh &	mesh,
		const dictionary &	dict )

static

Return a reference to the selected source type.

Definition at line 54 of file topoSetCellZoneSource.C.

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

Here is the call graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::topoSetCellZoneSource > New	(	const word &	sourceType,
		const polyMesh &	mesh,
		Istream &	is )

static

Return a reference to the selected source type.

Definition at line 79 of file topoSetCellZoneSource.C.

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

Here is the call graph for this function:

◆ setType()

virtual topoSetSource::sourceType setType ( ) const

inlinevirtual

The source category is a cellZone.

Implements topoSetSource.

Definition at line 145 of file topoSetCellZoneSource.H.

References topoSetSource::CELLZONE_SOURCE.

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

src/meshTools/topoSet/cellZoneSources/topoSetCellZoneSource/topoSetCellZoneSource.H
src/meshTools/topoSet/cellZoneSources/topoSetCellZoneSource/topoSetCellZoneSource.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ topoSetCellZoneSource() [1/2]

◆ topoSetCellZoneSource() [2/2]

◆ ~topoSetCellZoneSource()

Member Function Documentation

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ clone()

◆ New() [1/2]

◆ New() [2/2]

◆ setType()