cylinderToCell Class Reference

A topoSetSource to select cells based on cell centres inside a cylinder. More...

Inheritance diagram for cylinderToCell:

Collaboration diagram for cylinderToCell:

Public Member Functions
	TypeName ("cylinderToCell")
	Runtime type information. More...
	cylinderToCell (const polyMesh &mesh, const vector &p1, const vector &p2, const scalar radius)
	Construct from components. More...
	cylinderToCell (const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...
	cylinderToCell (const polyMesh &mesh, Istream &)
	Construct from Istream. More...
virtual	~cylinderToCell ()
	Destructor. More...
virtual sourceType	setType () const
virtual void	applyToSet (const topoSetSource::setAction action, topoSet &) const
Public Member Functions inherited from topoSetSource
	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)
	Construct from components. More...
autoPtr< topoSetSource >	clone () const
	Clone. More...
virtual	~topoSetSource ()
	Destructor. More...
const polyMesh &	mesh () const

Private Member Functions
void	combine (topoSet &set, const bool add) const

Private Attributes
vector	p1_
	First point on cylinder axis. More...
vector	p2_
	Second point on cylinder axis. More...
scalar	radius_
	Radius. More...

Static Private Attributes
static addToUsageTable	usage_
	Add usage string. More...

Additional Inherited Members
Public Types inherited from topoSetSource
enum	sourceType {   CELLSETSOURCE, FACESETSOURCE, POINTSETSOURCE, CELLZONESOURCE,   FACEZONESOURCE, POINTZONESOURCE }
	Enumeration defining the types of sources. More...
enum	setAction {   CLEAR, NEW, INVERT, ADD,   DELETE, SUBSET, LIST, REMOVE }
	Enumeration defining the valid actions. More...
Static Public Member Functions inherited from topoSetSource
static setAction	toAction (const word &actionName)
	Convert string to action. More...
static Istream &	checkIs (Istream &is)
	Check state of stream. 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...
Protected Member Functions inherited from topoSetSource
void	addOrDelete (topoSet &set, const label cellI, const bool) const
	Add (if bool) cellI to set or delete cellI from set. More...
Protected Attributes inherited from topoSetSource
const polyMesh &	mesh_
Static Protected Attributes inherited from topoSetSource
static HashTable< string > *	usageTablePtr_ = NULL
	A table of usage strings. More...

Detailed Description

A topoSetSource to select cells based on cell centres inside a cylinder.

Source files

• cylinderToCell.H
• cylinderToCell.C

Definition at line 48 of file cylinderToCell.H.

Constructor & Destructor Documentation

cylinderToCell() [1/3]

cylinderToCell	(	const polyMesh &	mesh,
		const vector &	p1,
		const vector &	p2,
		const scalar	radius
	)

Construct from components.

Definition at line 78 of file cylinderToCell.C.

cylinderToCell() [2/3]

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

Construct from dictionary.

Definition at line 93 of file cylinderToCell.C.

cylinderToCell() [3/3]

cylinderToCell	(	const polyMesh &	mesh,
		Istream &	is
	)

Construct from Istream.

Definition at line 107 of file cylinderToCell.C.

~cylinderToCell()

~cylinderToCell ( )

virtual

Destructor.

Definition at line 121 of file cylinderToCell.C.

Member Function Documentation

combine()

void combine ( topoSet &  set, const bool  add  ) const

private

Definition at line 50 of file cylinderToCell.C.

References Foam::add(), topoSetSource::addOrDelete(), primitiveMesh::cellCentres(), forAll, Foam::magSqr(), topoSetSource::mesh_, cylinderToCell::p1_, cylinderToCell::p2_, cylinderToCell::radius_, and Foam::sqr().

Here is the call graph for this function:

TypeName()

TypeName

(

"cylinderToCell"

)

Runtime type information.

setType()

virtual sourceType setType ( ) const

inlinevirtual

Implements topoSetSource.

Definition at line 111 of file cylinderToCell.H.

References topoSetSource::CELLSETSOURCE.

applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 128 of file cylinderToCell.C.

References topoSetSource::ADD, Foam::ListListOps::combine(), topoSetSource::DELETE, Foam::endl(), Foam::Info, and topoSetSource::NEW.

Here is the call graph for this function:

Field Documentation

usage_

Foam::topoSetSource::addToUsageTable usage_

staticprivate

Add usage string.

Definition at line 56 of file cylinderToCell.H.

p1_

vector p1_

private

First point on cylinder axis.

Definition at line 59 of file cylinderToCell.H.

Referenced by cylinderToCell::combine().

p2_

vector p2_

private

Second point on cylinder axis.

Definition at line 62 of file cylinderToCell.H.

Referenced by cylinderToCell::combine().

radius_

scalar radius_

private

Radius.

Definition at line 65 of file cylinderToCell.H.

Referenced by cylinderToCell::combine().

---

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

• src/meshTools/sets/cellSources/cylinderToCell/cylinderToCell.H
• src/meshTools/sets/cellSources/cylinderToCell/cylinderToCell.C