faceZoneToCell Class Reference

A topoSetCellSource to select cells based on master or slave side of given faceZone(s). More...

Inheritance diagram for faceZoneToCell:

Collaboration diagram for faceZoneToCell:

Public Types
enum	faceAction { MASTER, SLAVE }
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 }

Public Member Functions
	TypeName ("faceZoneToCell")
	faceZoneToCell (const polyMesh &mesh, const wordRes &zoneSelector, const faceAction option)
	faceZoneToCell (const polyMesh &mesh, const wordRe &zoneName, const faceAction option)
	faceZoneToCell (const polyMesh &mesh, const dictionary &dict)
	faceZoneToCell (const polyMesh &mesh, Istream &is)
virtual	~faceZoneToCell ()=default
const wordRes &	zones () const noexcept
void	zones (const wordRes &zoneSelector)
void	zones (const wordRe &zoneName)
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
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 cells based on master or slave side of given faceZone(s).

Operands:

Operand	Type	Location
input	faceZone(s)	$FOAM_CASE/constant/polyMesh/faceZones
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      faceZoneToCell;
    option      <option>;

    // Conditional mandatory entries
    // Select either of the below

    // Option-1
    zones
    (
        <faceZoneName1>
        <faceZoneName2>
        ...
    );

    // Option-2
    set <faceZoneName>;
}

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: faceZoneToCell	word	yes	-
option	Selection type - see below	word	yes	-

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

Options for the option entry:

      master   | Master side of the faceZone
      slave    | Slave side of the faceZone

Options for the conditional mandatory entries:

      Entry    | Description                    | Type     | Req'd  | Dflt
      zones    | Names of input faceZones       | wordRes  | cond'l | -
      zone     | Name of input faceZone         | wordRe   | cond'l | -

Note

The order of precedence among the conditional mandatory entries from the highest to the lowest is zones, and zone.

See also

• Foam::topoSetSource
• Foam::topoSetCellSource
• Foam::faceToCell

Source files

• faceZoneToCell.H
• faceZoneToCell.C

Definition at line 172 of file faceZoneToCell.H.

Member Enumeration Documentation

faceAction

enum faceAction

Enumerator
MASTER
SLAVE

Definition at line 178 of file faceZoneToCell.H.

Constructor & Destructor Documentation

faceZoneToCell() [1/4]

faceZoneToCell	(	const polyMesh &	mesh,
		const wordRes &	zoneSelector,
		const faceAction	option
	)

Definition at line 140 of file faceZoneToCell.C.

faceZoneToCell() [2/4]

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

Definition at line 153 of file faceZoneToCell.C.

faceZoneToCell() [3/4]

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

Definition at line 166 of file faceZoneToCell.C.

References dict, dictionary::getCompat(), and dictionary::readIfPresent().

Here is the call graph for this function:

faceZoneToCell() [4/4]

faceZoneToCell	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 186 of file faceZoneToCell.C.

~faceZoneToCell()

virtual ~faceZoneToCell ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"faceZoneToCell"

)

zones() [1/3]

const Foam::wordRes & zones ( ) const

noexcept

Definition at line 199 of file faceZoneToCell.C.

zones() [2/3]

void zones

(

const wordRes &

zoneSelector

)

Definition at line 205 of file faceZoneToCell.C.

zones() [3/3]

void zones

(

const wordRe &

zoneName

)

Definition at line 211 of file faceZoneToCell.C.

References List::resize().

Here is the call graph for this function:

applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 219 of file faceZoneToCell.C.

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

Here is the call graph for this function:

---

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