A topoSetCellSource to select all cells whose cell centre inside a given bounding cylinder annulus. More...

Inheritance diagram for cylinderAnnulusToCell:

Collaboration diagram for cylinderAnnulusToCell:

Public Member Functions
	TypeName ("cylinderAnnulusToCell")

	cylinderAnnulusToCell (const polyMesh &mesh, const point &point1, const point &point2, const scalar radius, const scalar innerRadius=0)

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

	cylinderAnnulusToCell (const polyMesh &mesh, Istream &is)

virtual	~cylinderAnnulusToCell ()=default

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

Public Member Functions inherited from topoSetCellSource
	declareRunTimeSelectionTable (autoPtr, topoSetCellSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))

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

	topoSetCellSource (const polyMesh &mesh)

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

autoPtr< topoSetCellSource >	clone () const

virtual	~topoSetCellSource ()=default

virtual topoSetSource::sourceType	setType () const

Public Member Functions inherited from topoSetSource
	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)

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 }

enum	setAction { ADD, NEW, SUBTRACT, SUBSET, INVERT, CLEAR, REMOVE, LIST, DELETE = SUBTRACT }

Static Public Member Functions inherited from topoSetCellSource
static autoPtr< topoSetCellSource >	New (const word &sourceType, const polyMesh &mesh, const dictionary &dict)

static autoPtr< topoSetCellSource >	New (const word &sourceType, const polyMesh &mesh, Istream &is)

Static Public Member Functions inherited from topoSetSource
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 inherited from topoSetSource
static const Enum< setAction >	actionNames

Protected Member Functions inherited from topoSetSource
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 inherited from topoSetSource
static bool	check (labelList &list, const label maxLabel)

Protected Attributes inherited from topoSetSource
const polyMesh &	mesh_

bool	verbose_

Static Protected Attributes inherited from topoSetSource
static const string	illegalSource_

static HashTable< string > *	usageTablePtr_ = nullptr

Detailed Description

A topoSetCellSource to select all cells whose cell centre inside a given bounding cylinder annulus.

Operands:

Operand	Type	Location
`output`	cellSet	$FOAM_CASE/constant/polyMesh/sets/<set>

Usage

Minimal example by using system/topoSetDict.actions:

{
    // Mandatory (inherited) entries
    name           <name>;
    type           cellSet;
    action         <action>;

    // Mandatory entries
    source         cylinderAnnulusToCell;
    p1             (<p1X> <p1Y> <p1Z>);
    p2             (<p2X> <p2Y> <p2Z>);
    outerRadius    <radius1>;

    // Optional entries
    innerRadius    <radius2>;
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`name`	Name of cellSet	word	yes	-
`type`	Type name: cellSet	word	yes	-
`action`	Action applied on cells - see below	word	yes	-
`source`	Source name: cylinderAnnulusToCell	word	yes	-
`p1`	Coordinate of one of the endpoints	vector	yes	-
`p2`	Coordinate of the other endpoint	vector	yes	-
`outerRadius`	Cylinder outer radius	scalar	yes	-
`innerRadius`	Cylinder inner radius	scalar	no	0

Options for the action entry:

      new      | Create a new cellSet from selected cells
      add      | Add selected cells into this cellSet
      subtract | Remove selected cells from this cellSet

See also

Source files

Definition at line 164 of file cylinderAnnulusToCell.H.

Constructor & Destructor Documentation

◆ cylinderAnnulusToCell() [1/3]

cylinderAnnulusToCell	(	const polyMesh &	mesh,
		const point &	point1,
		const point &	point2,
		const scalar	radius,
		const scalar	innerRadius = `0`
	)

Definition at line 104 of file cylinderAnnulusToCell.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ cylinderAnnulusToCell() [2/3]

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

Definition at line 129 of file cylinderAnnulusToCell.C.

◆ cylinderAnnulusToCell() [3/3]

cylinderAnnulusToCell	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 146 of file cylinderAnnulusToCell.C.

◆ ~cylinderAnnulusToCell()

virtual ~cylinderAnnulusToCell ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "cylinderAnnulusToCell" )

◆ applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 162 of file cylinderAnnulusToCell.C.

References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::endl(), Foam::Info, topoSetSource::NEW, Foam::BitOps::set(), and topoSetSource::SUBTRACT.