setsToFaceZone Class Reference

A topoSetSource to select all faces in a given faceSet, which are oriented in slave cells of a given cellSet. More...

Inheritance diagram for setsToFaceZone:

Collaboration diagram for setsToFaceZone:

Public Member Functions
	TypeName ("setsToFaceZone")
	setsToFaceZone (const polyMesh &mesh, const word &faceSetName, const word &cellSetName, const bool flip)
	setsToFaceZone (const polyMesh &mesh, const dictionary &dict)
	setsToFaceZone (const polyMesh &mesh, Istream &is)
virtual	~setsToFaceZone ()=default
virtual void	applyToSet (const topoSetSource::setAction action, topoSet &set) const
Public Member Functions inherited from topoSetFaceZoneSource
	declareRunTimeSelectionTable (autoPtr, topoSetFaceZoneSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
	declareRunTimeSelectionTable (autoPtr, topoSetFaceZoneSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
	topoSetFaceZoneSource (const polyMesh &mesh)
	topoSetFaceZoneSource (const polyMesh &mesh, const dictionary &dict)
autoPtr< topoSetFaceZoneSource >	clone () const
virtual	~topoSetFaceZoneSource ()=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 topoSetFaceZoneSource
static autoPtr< topoSetFaceZoneSource >	New (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
static autoPtr< topoSetFaceZoneSource >	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 topoSetSource to select all faces in a given faceSet, which are oriented in slave cells of a given cellSet.

Operands:

Operand	Type	Location
input 1	faceSet	$FOAM_CASE/constant/polyMesh/sets/<set>
input 2	cellSet	$FOAM_CASE/constant/polyMesh/sets/<set>
output	faceZone	$FOAM_CASE/constant/polyMesh/faceZones

Usage

Minimal example by using system/topoSetDict.actions:

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

    // Mandatory entries
    source      setToFaceZone;
    faceSet     <faceSetName>;
    cellSet     <cellSetName>;

    // Optional entries
    flip        false;
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
name	Name of faceZone	word	yes	-
type	Type name: faceZoneSet	word	yes	-
action	Action applied on faces - see below	word	yes	-
source	Source name: setsToFaceZone	word	yes	-
faceSet	Name of input faceSet	word	yes	-
cellSet	Name of input cellSet containing the slave cells	word	yes	-
flip	Flag to select master/slave cells	bool	no	false

Options for the action entry:

      new      | Create a new faceZone from selected faces
      add      | Add selected faces of a faceZoneSet into this faceZone
      subtract | Remove selected faces of a faceZoneSet from this faceZone

See also

• Foam::topoSetSource

Source files

• setsToFaceZone.H
• setsToFaceZone.C

Definition at line 164 of file setsToFaceZone.H.

Constructor & Destructor Documentation

setsToFaceZone() [1/3]

setsToFaceZone	(	const polyMesh &	mesh,
		const word &	faceSetName,
		const word &	cellSetName,
		const bool	flip
	)

Definition at line 53 of file setsToFaceZone.C.

setsToFaceZone() [2/3]

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

Definition at line 68 of file setsToFaceZone.C.

setsToFaceZone() [3/3]

setsToFaceZone	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 81 of file setsToFaceZone.C.

~setsToFaceZone()

virtual ~setsToFaceZone ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"setsToFaceZone"

)

applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 96 of file setsToFaceZone.C.

References faceZoneSet::addressing(), DynamicList::append(), Foam::endl(), faceZoneSet::flipMap(), forAll, topoSet::found(), Foam::Info, IOobject::name(), Foam::BitOps::set(), List::transfer(), faceZoneSet::updateSet(), and WarningInFunction.

Here is the call graph for this function:

---

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

• src/meshTools/sets/faceZoneSources/setsToFaceZone/setsToFaceZone.H
• src/meshTools/sets/faceZoneSources/setsToFaceZone/setsToFaceZone.C