topoSetSource Class Reference

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

#include <topoSetSource.H>

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 , SUBTRACT , NEW , SUBSET ,   INVERT , CLEAR , REMOVE , LIST ,   IGNORE , DELETE = SUBTRACT }
	Enumeration defining various actions. More...

Public Member Functions
	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 sourceType	setType () const =0
	The source category (cell/face/point combined with set/zone).
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 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.

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

Protected Attributes
const polyMesh &	mesh_
	Reference to the mesh.
bool	verbose_
	Output verbosity (default: true).
autoPtr< solidBodyMotionFunction >	transformPtr_
	Optional transformation for geometric data.

Static Protected Attributes
static const string	illegalSource_
static HashTable< string > *	usageTablePtr_ = nullptr
	A table of usage strings.

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/SUBTRACT/NEW).

Source files

• topoSetSource.H
• topoSetSource.C

Definition at line 63 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 72 of file topoSetSource.H.

setAction

enum setAction

Enumeration defining various actions.

Enumerator
ADD	Add elements to current set.
SUBTRACT	Subtract elements from current set.
NEW	Create a new set and ADD elements to it.
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.
IGNORE	"ignore" no-op action
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.

References topoSetSource().

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), operator=(), topoSetCellSource::topoSetCellSource(), topoSetCellSource::topoSetCellSource(), topoSetCellZoneSource::topoSetCellZoneSource(), topoSetCellZoneSource::topoSetCellZoneSource(), topoSetFaceSource::topoSetFaceSource(), topoSetFaceSource::topoSetFaceSource(), topoSetFaceZoneSource::topoSetFaceZoneSource(), topoSetFaceZoneSource::topoSetFaceZoneSource(), topoSetPointSource::topoSetPointSource(), topoSetPointSource::topoSetPointSource(), topoSetPointZoneSource::topoSetPointZoneSource(), topoSetPointZoneSource::topoSetPointZoneSource(), and topoSetSource().

Here is the call graph for this function:

Here is the caller graph for this function:

topoSetSource() [2/3]

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

explicit

Construct from mesh, with preferred verbosity.

Definition at line 242 of file topoSetSource.C.

References mesh(), mesh_, transformPtr_, verbose(), and verbose_.

Here is the call graph for this function:

topoSetSource() [3/3]

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

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

Definition at line 254 of file topoSetSource.C.

References dict, mesh(), mesh_, transformPtr_, and verbose_.

Here is the call graph for this function:

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

References List< T >::resize(), and UList< T >::size().

Referenced by labelToCell::labelToCell(), labelToFace::labelToFace(), and labelToPoint::labelToPoint().

Here is the call graph for this function:

Here is the caller 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 180 of file topoSetSource.C.

References Foam::add().

Referenced by labelToCell::applyToSet(), labelToFace::applyToSet(), labelToPoint::applyToSet(), and holeToFace::combine().

Here is the call graph for this function:

Here is the caller 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 198 of file topoSetSource.C.

References Foam::add().

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

References Foam::add().

Here is the call graph for this function:

operator=()

void operator= ( const topoSetSource & )

protecteddelete

No copy assignment.

References topoSetSource().

Here is the call graph for this function:

TypeName()

TypeName

(

"topoSetSource"

)

Runtime type information.

checkIs()

Foam::Istream & checkIs ( Istream & is )

static

Check state of stream.

Definition at line 166 of file topoSetSource.C.

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

Referenced by boxToCell::boxToCell(), boxToFace::boxToFace(), boxToPoint::boxToPoint(), cellToCell::cellToCell(), cellToFace::cellToFace(), cellToFaceZone::cellToFaceZone(), cellToPoint::cellToPoint(), clipPlaneToCell::clipPlaneToCell(), clipPlaneToFace::clipPlaneToFace(), clipPlaneToPoint::clipPlaneToPoint(), cylinderToCell::cylinderToCell(), cylinderToFace::cylinderToFace(), cylinderToPoint::cylinderToPoint(), faceToCell::faceToCell(), faceToFace::faceToFace(), faceToPoint::faceToPoint(), faceZoneToCell::faceZoneToCell(), faceZoneToFaceZone::faceZoneToFaceZone(), fieldToCell::fieldToCell(), holeToFace::holeToFace(), labelToCell::labelToCell(), labelToFace::labelToFace(), labelToPoint::labelToPoint(), nbrToCell::nbrToCell(), nearestToCell::nearestToCell(), nearestToPoint::nearestToPoint(), normalToFace::normalToFace(), patchToCell::patchToCell(), patchToFace::patchToFace(), patchToPoint::patchToPoint(), planeToFaceZone::planeToFaceZone(), pointToCell::pointToCell(), pointToFace::pointToFace(), pointToPoint::pointToPoint(), regionsToCell::regionsToCell(), regionToCell::regionToCell(), regionToFace::regionToFace(), setAndNormalToFaceZone::setAndNormalToFaceZone(), setsToFaceZone::setsToFaceZone(), setToCellZone::setToCellZone(), setToFaceZone::setToFaceZone(), setToPointZone::setToPointZone(), shapeToCell::shapeToCell(), sphereToCell::sphereToCell(), sphereToFace::sphereToFace(), sphereToPoint::sphereToPoint(), surfaceToCell::surfaceToCell(), surfaceToPoint::surfaceToPoint(), targetVolumeToCell::targetVolumeToCell(), zoneToCell::zoneToCell(), zoneToFace::zoneToFace(), and zoneToPoint::zoneToPoint().

Here is the call graph for this function:

isSetSource()

bool isSetSource ( const sourceType t )

inlinestaticnoexcept

True if a "set" source.

Definition at line 253 of file topoSetSource.H.

References SET_SOURCE.

isZoneSource()

bool isZoneSource ( const sourceType t )

inlinestaticnoexcept

True if a "zone" source.

Definition at line 261 of file topoSetSource.H.

References ZONE_SOURCE.

isCell()

bool isCell ( const sourceType t )

inlinestaticnoexcept

True if "cell" geometric type.

Definition at line 269 of file topoSetSource.H.

References CELL_TYPE.

isFace()

bool isFace ( const sourceType t )

inlinestaticnoexcept

True if "face" geometric type.

Definition at line 277 of file topoSetSource.H.

References FACE_TYPE.

isPoint()

bool isPoint ( const sourceType t )

inlinestaticnoexcept

True if "point" geometric type.

Definition at line 285 of file topoSetSource.H.

References POINT_TYPE.

declareRunTimeSelectionTable() [1/2]

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

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

Here is the call graph for this function:

declareRunTimeSelectionTable() [2/2]

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

References mesh(), and topoSetSource().

Here is the call graph for this function:

usage()

const string & usage ( const word & name )

inlinestatic

Definition at line 345 of file topoSetSource.H.

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

Here is the call graph for this function:

clone()

autoPtr< topoSetSource > clone ( ) const

inline

Clone (disallowed).

Definition at line 372 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 119 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 143 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 413 of file topoSetSource.H.

References mesh_, and Foam::noexcept.

Referenced by badQualityToCell::badQualityToCell(), badQualityToCell::badQualityToCell(), badQualityToFace::badQualityToFace(), badQualityToFace::badQualityToFace(), boundaryToCell::boundaryToCell(), boundaryToCell::boundaryToCell(), boundaryToCell::boundaryToCell(), boundaryToFace::boundaryToFace(), boundaryToFace::boundaryToFace(), boundaryToFace::boundaryToFace(), boxToCell::boxToCell(), boxToCell::boxToCell(), boxToCell::boxToCell(), boxToCell::boxToCell(), boxToFace::boxToFace(), boxToFace::boxToFace(), boxToFace::boxToFace(), boxToFace::boxToFace(), boxToPoint::boxToPoint(), boxToPoint::boxToPoint(), boxToPoint::boxToPoint(), boxToPoint::boxToPoint(), holeToFace::calcClosure(), cellToCell::cellToCell(), cellToCell::cellToCell(), cellToCell::cellToCell(), cellToFace::cellToFace(), cellToFace::cellToFace(), cellToFace::cellToFace(), cellToFaceZone::cellToFaceZone(), cellToFaceZone::cellToFaceZone(), cellToFaceZone::cellToFaceZone(), cellToPoint::cellToPoint(), cellToPoint::cellToPoint(), cellToPoint::cellToPoint(), clipPlaneToCell::clipPlaneToCell(), clipPlaneToCell::clipPlaneToCell(), clipPlaneToCell::clipPlaneToCell(), clipPlaneToCell::clipPlaneToCell(), clipPlaneToFace::clipPlaneToFace(), clipPlaneToFace::clipPlaneToFace(), clipPlaneToFace::clipPlaneToFace(), clipPlaneToFace::clipPlaneToFace(), clipPlaneToPoint::clipPlaneToPoint(), clipPlaneToPoint::clipPlaneToPoint(), clipPlaneToPoint::clipPlaneToPoint(), clipPlaneToPoint::clipPlaneToPoint(), cylinderAnnulusToCell::cylinderAnnulusToCell(), cylinderAnnulusToCell::cylinderAnnulusToCell(), cylinderAnnulusToCell::cylinderAnnulusToCell(), cylinderAnnulusToFace::cylinderAnnulusToFace(), cylinderAnnulusToFace::cylinderAnnulusToFace(), cylinderAnnulusToFace::cylinderAnnulusToFace(), cylinderToCell::cylinderToCell(), cylinderToCell::cylinderToCell(), cylinderToCell::cylinderToCell(), cylinderToCell::cylinderToCell(), cylinderToFace::cylinderToFace(), cylinderToFace::cylinderToFace(), cylinderToFace::cylinderToFace(), cylinderToFace::cylinderToFace(), cylinderToPoint::cylinderToPoint(), cylinderToPoint::cylinderToPoint(), cylinderToPoint::cylinderToPoint(), cylinderToPoint::cylinderToPoint(), topoSetCellSource::declareRunTimeSelectionTable(), topoSetCellSource::declareRunTimeSelectionTable(), topoSetCellZoneSource::declareRunTimeSelectionTable(), topoSetCellZoneSource::declareRunTimeSelectionTable(), topoSetFaceSource::declareRunTimeSelectionTable(), topoSetFaceSource::declareRunTimeSelectionTable(), topoSetFaceZoneSource::declareRunTimeSelectionTable(), topoSetFaceZoneSource::declareRunTimeSelectionTable(), topoSetPointSource::declareRunTimeSelectionTable(), topoSetPointSource::declareRunTimeSelectionTable(), topoSetPointZoneSource::declareRunTimeSelectionTable(), topoSetPointZoneSource::declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), faceToCell::faceToCell(), faceToCell::faceToCell(), faceToCell::faceToCell(), faceToFace::faceToFace(), faceToFace::faceToFace(), faceToFace::faceToFace(), faceToPoint::faceToPoint(), faceToPoint::faceToPoint(), faceToPoint::faceToPoint(), faceZoneToCell::faceZoneToCell(), faceZoneToCell::faceZoneToCell(), faceZoneToCell::faceZoneToCell(), faceZoneToCell::faceZoneToCell(), faceZoneToFaceZone::faceZoneToFaceZone(), faceZoneToFaceZone::faceZoneToFaceZone(), faceZoneToFaceZone::faceZoneToFaceZone(), fieldToCell::fieldToCell(), fieldToCell::fieldToCell(), fieldToCell::fieldToCell(), haloToCell::haloToCell(), haloToCell::haloToCell(), haloToCell::haloToCell(), holeToFace::holeToFace(), holeToFace::holeToFace(), holeToFace::holeToFace(), topoSetSource::iNew::iNew(), labelToCell::labelToCell(), labelToCell::labelToCell(), labelToCell::labelToCell(), labelToCell::labelToCell(), labelToFace::labelToFace(), labelToFace::labelToFace(), labelToFace::labelToFace(), labelToFace::labelToFace(), labelToPoint::labelToPoint(), labelToPoint::labelToPoint(), labelToPoint::labelToPoint(), labelToPoint::labelToPoint(), nbrToCell::nbrToCell(), nbrToCell::nbrToCell(), nbrToCell::nbrToCell(), nearestToCell::nearestToCell(), nearestToCell::nearestToCell(), nearestToCell::nearestToCell(), nearestToCell::nearestToCell(), nearestToPoint::nearestToPoint(), nearestToPoint::nearestToPoint(), nearestToPoint::nearestToPoint(), nearestToPoint::nearestToPoint(), topoSetCellSource::New(), topoSetCellSource::New(), topoSetCellZoneSource::New(), topoSetCellZoneSource::New(), topoSetFaceSource::New(), topoSetFaceSource::New(), topoSetFaceZoneSource::New(), topoSetFaceZoneSource::New(), topoSetPointSource::New(), topoSetPointSource::New(), topoSetPointZoneSource::New(), topoSetPointZoneSource::New(), New(), New(), normalToFace::normalToFace(), normalToFace::normalToFace(), normalToFace::normalToFace(), patchToCell::patchToCell(), patchToCell::patchToCell(), patchToCell::patchToCell(), patchToFace::patchToFace(), patchToFace::patchToFace(), patchToFace::patchToFace(), patchToPoint::patchToPoint(), patchToPoint::patchToPoint(), patchToPoint::patchToPoint(), planeToFaceZone::planeToFaceZone(), planeToFaceZone::planeToFaceZone(), planeToFaceZone::planeToFaceZone(), planeToFaceZone::planeToFaceZone(), pointToCell::pointToCell(), pointToCell::pointToCell(), pointToCell::pointToCell(), pointToFace::pointToFace(), pointToFace::pointToFace(), pointToFace::pointToFace(), pointToPoint::pointToPoint(), pointToPoint::pointToPoint(), pointToPoint::pointToPoint(), regionsToCell::regionsToCell(), regionsToCell::regionsToCell(), regionsToCell::regionsToCell(), regionToCell::regionToCell(), regionToCell::regionToCell(), regionToCell::regionToCell(), regionToFace::regionToFace(), regionToFace::regionToFace(), regionToFace::regionToFace(), rotatedBoxToCell::rotatedBoxToCell(), rotatedBoxToCell::rotatedBoxToCell(), rotatedBoxToCell::rotatedBoxToCell(), searchableSurfaceToCell::searchableSurfaceToCell(), searchableSurfaceToCell::searchableSurfaceToCell(), searchableSurfaceToFace::searchableSurfaceToFace(), searchableSurfaceToFace::searchableSurfaceToFace(), searchableSurfaceToFaceZone::searchableSurfaceToFaceZone(), searchableSurfaceToFaceZone::searchableSurfaceToFaceZone(), searchableSurfaceToPoint::searchableSurfaceToPoint(), searchableSurfaceToPoint::searchableSurfaceToPoint(), setAndNormalToFaceZone::setAndNormalToFaceZone(), setAndNormalToFaceZone::setAndNormalToFaceZone(), setAndNormalToFaceZone::setAndNormalToFaceZone(), setsToFaceZone::setsToFaceZone(), setsToFaceZone::setsToFaceZone(), setsToFaceZone::setsToFaceZone(), setToCellZone::setToCellZone(), setToCellZone::setToCellZone(), setToCellZone::setToCellZone(), setToFaceZone::setToFaceZone(), setToFaceZone::setToFaceZone(), setToFaceZone::setToFaceZone(), setToPointZone::setToPointZone(), setToPointZone::setToPointZone(), setToPointZone::setToPointZone(), shapeToCell::shapeToCell(), shapeToCell::shapeToCell(), shapeToCell::shapeToCell(), sphereToCell::sphereToCell(), sphereToCell::sphereToCell(), sphereToCell::sphereToCell(), sphereToFace::sphereToFace(), sphereToFace::sphereToFace(), sphereToFace::sphereToFace(), sphereToPoint::sphereToPoint(), sphereToPoint::sphereToPoint(), sphereToPoint::sphereToPoint(), surfaceToCell::surfaceToCell(), surfaceToCell::surfaceToCell(), surfaceToCell::surfaceToCell(), surfaceToCell::surfaceToCell(), surfaceToPoint::surfaceToPoint(), surfaceToPoint::surfaceToPoint(), surfaceToPoint::surfaceToPoint(), targetVolumeToCell::targetVolumeToCell(), targetVolumeToCell::targetVolumeToCell(), targetVolumeToCell::targetVolumeToCell(), topoSetCellSource::topoSetCellSource(), topoSetCellSource::topoSetCellSource(), topoSetCellZoneSource::topoSetCellZoneSource(), topoSetCellZoneSource::topoSetCellZoneSource(), topoSetFaceSource::topoSetFaceSource(), topoSetFaceSource::topoSetFaceSource(), topoSetFaceZoneSource::topoSetFaceZoneSource(), topoSetFaceZoneSource::topoSetFaceZoneSource(), topoSetPointSource::topoSetPointSource(), topoSetPointSource::topoSetPointSource(), topoSetPointZoneSource::topoSetPointZoneSource(), topoSetPointZoneSource::topoSetPointZoneSource(), topoSetSource(), topoSetSource(), badQualityToCell::TypeName(), badQualityToFace::TypeName(), boundaryToCell::TypeName(), boundaryToFace::TypeName(), boxToCell::TypeName(), boxToFace::TypeName(), boxToPoint::TypeName(), cellToCell::TypeName(), cellToFace::TypeName(), cellToFaceZone::TypeName(), cellToPoint::TypeName(), cylinderAnnulusToCell::TypeName(), cylinderAnnulusToFace::TypeName(), cylinderToCell::TypeName(), cylinderToFace::TypeName(), cylinderToPoint::TypeName(), faceToCell::TypeName(), faceToFace::TypeName(), faceToPoint::TypeName(), faceZoneToCell::TypeName(), faceZoneToFaceZone::TypeName(), fieldToCell::TypeName(), haloToCell::TypeName(), holeToFace::TypeName(), labelToCell::TypeName(), labelToFace::TypeName(), labelToPoint::TypeName(), nbrToCell::TypeName(), nearestToCell::TypeName(), nearestToPoint::TypeName(), normalToFace::TypeName(), patchToCell::TypeName(), patchToFace::TypeName(), patchToPoint::TypeName(), pointToCell::TypeName(), pointToFace::TypeName(), pointToPoint::TypeName(), regionsToCell::TypeName(), regionToCell::TypeName(), regionToFace::TypeName(), rotatedBoxToCell::TypeName(), searchableSurfaceToCell::TypeName(), searchableSurfaceToFace::TypeName(), searchableSurfaceToFaceZone::TypeName(), searchableSurfaceToPoint::TypeName(), setAndNormalToFaceZone::TypeName(), setsToFaceZone::TypeName(), setToCellZone::TypeName(), setToFaceZone::TypeName(), setToPointZone::TypeName(), sphereToCell::TypeName(), sphereToFace::TypeName(), sphereToPoint::TypeName(), surfaceToCell::TypeName(), surfaceToPoint::TypeName(), targetVolumeToCell::TypeName(), zoneToCell::TypeName(), zoneToFace::TypeName(), zoneToPoint::TypeName(), zoneToCell::zoneToCell(), zoneToCell::zoneToCell(), zoneToCell::zoneToCell(), zoneToCell::zoneToCell(), zoneToCell::zoneToCell(), zoneToFace::zoneToFace(), zoneToFace::zoneToFace(), zoneToFace::zoneToFace(), zoneToFace::zoneToFace(), zoneToFace::zoneToFace(), zoneToPoint::zoneToPoint(), zoneToPoint::zoneToPoint(), zoneToPoint::zoneToPoint(), zoneToPoint::zoneToPoint(), zoneToPoint::zoneToPoint(), and holeToFace::~holeToFace().

verbose() [1/3]

bool verbose ( ) const

inlinenoexcept

Get output verbosity.

Definition at line 421 of file topoSetSource.H.

References Foam::noexcept, and verbose_.

Referenced by topoSetSource().

Here is the caller graph for this function:

verbose() [2/3]

bool verbose ( bool on )

inlinenoexcept

Enable/disable verbose output.

Returns

old value

Definition at line 431 of file topoSetSource.H.

References verbose_.

verbose() [3/3]

void verbose

(

const dictionary &

dict

)

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

Definition at line 272 of file topoSetSource.C.

References dict, keyType::LITERAL, and verbose_.

setType()

virtual sourceType setType ( ) const

pure virtual

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

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

applyToSet()

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

pure virtual

Apply specified action to the topoSet.

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

hasTransform()

bool hasTransform ( ) const

inlinenoexcept

True if coordinate transform is active.

Definition at line 464 of file topoSetSource.H.

References Foam::noexcept, and transformPtr_.

transform()

Foam::tmp< Foam::pointField > transform

(

const pointField &

points

)

const

Coordinate transform (optionally) coordinates. Returns reference to input data if no transform is active.

Definition at line 283 of file topoSetSource.C.

References points, Foam::transformPoints(), and transformPtr_.

Here is the call graph for this function:

toAction()

setAction toAction ( const word & actionName )

inlinestatic

Deprecated(2018-07) convert string to action.

Deprecated

(2018-07) - use actionNames[] directly

Definition at line 480 of file topoSetSource.H.

References actionNames.

readNames()

bool readNames ( const dictionary & dict, wordList & names )

static

Helper: extract wordList of patches/zones from dictionary. Returns.

true if zone(s). Order of parsing is sets, zones, set, zone

Definition at line 300 of file topoSetSource.C.

References dict, keyType::LITERAL, and names.

Referenced by cellToCell::cellToCell(), cellToFace::cellToFace(), cellToFaceZone::cellToFaceZone(), cellToPoint::cellToPoint(), faceToCell::faceToCell(), faceToFace::faceToFace(), faceToPoint::faceToPoint(), pointToCell::pointToCell(), pointToFace::pointToFace(), and pointToPoint::pointToPoint().

Here is the caller graph for this function:

Member Data Documentation

actionNames

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

static

The setActions enum text. Names: "new", add", "subtract", "subset", "invert", "clear", "remove", "list", "ignore".

Definition at line 123 of file topoSetSource.H.

Referenced by toAction().

combineNames

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

static

The setAction enum text when combining selections. Names: "use", "add", "subtract", "subset", "invert", "ignore".

Note

The "use" is like "new" (start from empty + ADD)

Definition at line 132 of file topoSetSource.H.

Referenced by cellBitSet::select().

illegalSource_

const Foam::string illegalSource_

staticprotected

Definition at line 137 of file topoSetSource.H.

Referenced by usage().

usageTablePtr_

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

staticprotected

A table of usage strings.

Definition at line 142 of file topoSetSource.H.

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

mesh_

const polyMesh& mesh_

protected

Reference to the mesh.

Definition at line 176 of file topoSetSource.H.

Referenced by cellToCell::applyToSet(), cellToFaceZone::applyToSet(), faceToFace::applyToSet(), faceZoneToFaceZone::applyToSet(), holeToFace::applyToSet(), normalToFace::applyToSet(), pointToPoint::applyToSet(), regionToFace::applyToSet(), searchableSurfaceToFaceZone::applyToSet(), setAndNormalToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), setToCellZone::applyToSet(), setToFaceZone::applyToSet(), setToPointZone::applyToSet(), targetVolumeToCell::applyToSet(), holeToFace::combine(), mesh(), topoSetSource(), and topoSetSource().

verbose_

bool verbose_

protected

Output verbosity (default: true).

Definition at line 181 of file topoSetSource.H.

Referenced by badQualityToCell::applyToSet(), badQualityToFace::applyToSet(), boundaryToCell::applyToSet(), boundaryToFace::applyToSet(), boxToCell::applyToSet(), boxToFace::applyToSet(), boxToPoint::applyToSet(), cellToCell::applyToSet(), cellToFace::applyToSet(), cellToFaceZone::applyToSet(), cellToPoint::applyToSet(), clipPlaneToCell::applyToSet(), clipPlaneToFace::applyToSet(), clipPlaneToPoint::applyToSet(), cylinderToCell::applyToSet(), cylinderToFace::applyToSet(), cylinderToPoint::applyToSet(), faceToCell::applyToSet(), faceToFace::applyToSet(), faceToPoint::applyToSet(), faceZoneToCell::applyToSet(), faceZoneToFaceZone::applyToSet(), haloToCell::applyToSet(), holeToFace::applyToSet(), labelToCell::applyToSet(), labelToFace::applyToSet(), labelToPoint::applyToSet(), nbrToCell::applyToSet(), nearestToCell::applyToSet(), nearestToPoint::applyToSet(), normalToFace::applyToSet(), patchToCell::applyToSet(), patchToFace::applyToSet(), patchToPoint::applyToSet(), planeToFaceZone::applyToSet(), pointToCell::applyToSet(), pointToFace::applyToSet(), pointToPoint::applyToSet(), regionsToCell::applyToSet(), regionToCell::applyToSet(), regionToFace::applyToSet(), rotatedBoxToCell::applyToSet(), searchableSurfaceToCell::applyToSet(), searchableSurfaceToFace::applyToSet(), searchableSurfaceToFaceZone::applyToSet(), searchableSurfaceToPoint::applyToSet(), setAndNormalToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), setToCellZone::applyToSet(), setToFaceZone::applyToSet(), setToPointZone::applyToSet(), shapeToCell::applyToSet(), sphereToCell::applyToSet(), sphereToFace::applyToSet(), sphereToPoint::applyToSet(), surfaceToCell::applyToSet(), surfaceToPoint::applyToSet(), targetVolumeToCell::applyToSet(), zoneToCell::applyToSet(), zoneToFace::applyToSet(), zoneToPoint::applyToSet(), topoSetSource(), topoSetSource(), verbose(), verbose(), and verbose().

transformPtr_

autoPtr<solidBodyMotionFunction> transformPtr_

protected

Optional transformation for geometric data.

Definition at line 186 of file topoSetSource.H.

Referenced by hasTransform(), topoSetSource(), topoSetSource(), and transform().

---

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

• src/meshTools/topoSet/topoSetSource/topoSetSource.H
• src/meshTools/topoSet/topoSetSource/topoSetSource.C