faceZoneToCell Class Reference

A topoSetSource to select cells based on side of faceZone. More...

Inheritance diagram for faceZoneToCell:

Collaboration diagram for faceZoneToCell:

Public Types
enum	faceAction { MASTER, SLAVE }
	Enumeration defining the valid options. More...
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...

Public Member Functions
	TypeName ("faceZoneToCell")
	Runtime type information. More...
	faceZoneToCell (const polyMesh &mesh, const word &zoneName, const faceAction option)
	Construct from components. More...
	faceZoneToCell (const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...
	faceZoneToCell (const polyMesh &mesh, Istream &)
	Construct from Istream. More...
virtual	~faceZoneToCell ()
	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
wordRe	zoneName_
	Name/regular expression of faceZone. More...
faceAction	option_
	Option. More...

Static Private Attributes
static const NamedEnum< faceAction, 2 >	faceActionNames_
static addToUsageTable	usage_
	Add usage string. More...

Additional Inherited Members
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 side of faceZone.

Source files

• faceZoneToCell.H
• faceZoneToCell.C

Definition at line 49 of file faceZoneToCell.H.

Member Enumeration Documentation

faceAction

enum faceAction

Enumeration defining the valid options.

Enumerator
MASTER
SLAVE

Definition at line 55 of file faceZoneToCell.H.

Constructor & Destructor Documentation

faceZoneToCell() [1/3]

faceZoneToCell	(	const polyMesh &	mesh,
		const word &	zoneName,
		const faceAction	option
	)

Construct from components.

Definition at line 114 of file faceZoneToCell.C.

faceZoneToCell() [2/3]

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

Construct from dictionary.

Definition at line 128 of file faceZoneToCell.C.

faceZoneToCell() [3/3]

faceZoneToCell	(	const polyMesh &	mesh,
		Istream &	is
	)

Construct from Istream.

Definition at line 141 of file faceZoneToCell.C.

~faceZoneToCell()

~faceZoneToCell ( )

virtual

Destructor.

Definition at line 154 of file faceZoneToCell.C.

Member Function Documentation

combine()

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

private

Definition at line 67 of file faceZoneToCell.C.

References Foam::add(), topoSetSource::addOrDelete(), Foam::endl(), polyMesh::faceZones(), forAll, Foam::Info, faceZoneToCell::MASTER, wordRe::match(), topoSetSource::mesh_, zone::name(), ZoneMesh::names(), primitiveMesh::nCells(), faceZoneToCell::option_, List::size(), WarningInFunction, and faceZoneToCell::zoneName_.

Here is the call graph for this function:

TypeName()

TypeName

(

"faceZoneToCell"

)

Runtime type information.

setType()

virtual sourceType setType ( ) const

inlinevirtual

Implements topoSetSource.

Definition at line 118 of file faceZoneToCell.H.

References topoSetSource::CELLSETSOURCE.

applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 161 of file faceZoneToCell.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

faceActionNames_

const Foam::NamedEnum< Foam::faceZoneToCell::faceAction, 2 > faceActionNames_

staticprivate

Definition at line 65 of file faceZoneToCell.H.

usage_

Foam::topoSetSource::addToUsageTable usage_

staticprivate

Add usage string.

Definition at line 68 of file faceZoneToCell.H.

zoneName_

wordRe zoneName_

private

Name/regular expression of faceZone.

Definition at line 71 of file faceZoneToCell.H.

Referenced by faceZoneToCell::combine().

option_

faceAction option_

private

Option.

Definition at line 74 of file faceZoneToCell.H.

Referenced by faceZoneToCell::combine().

---

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

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