searchableSurfaceToFaceZone Class Reference

A topoSetSource to select all faces whose cell-cell centre vector intersects with a given searchableSurface. More...

Inheritance diagram for searchableSurfaceToFaceZone:

Collaboration diagram for searchableSurfaceToFaceZone:

Public Member Functions
	TypeName ("searchableSurfaceToFaceZone")
	searchableSurfaceToFaceZone (const word &surfaceType, const polyMesh &mesh, const dictionary &dict)
	searchableSurfaceToFaceZone (const polyMesh &mesh, const dictionary &dict)
virtual	~searchableSurfaceToFaceZone ()=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)

Static Protected Member Functions
static word	getSurfaceName (const dictionary &dict, const word &defaultName)
Static Protected Member Functions inherited from topoSetSource
static bool	check (labelList &list, const label maxLabel)

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
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 whose cell-cell centre vector intersects with a given searchableSurface.

Operands:

Operand	Type	Location
input	triSurface	$FOAM_CASE/constant/triSurface/<file>
output 1	faceSet	$FOAM_CASE/constant/polyMesh/sets/<set>
output 2	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      searchableSurfaceToFaceZone;
    surfaceType <surfaceTypeName>;

    // Optional entries
    surfaceName <surfaceName>;
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
name	Name of faceZone	word	yes	-
type	Type name: faceZone	word	yes	-
action	Action applied on faces - see below	word	yes	-
source	Source name: searchableSurfaceToFaceZone	word	yes	-
surfaceType	The searchable surface type	word	yes	-
surfaceName	Name for the IOobject	word	no	mesh-name

Options for the action entry:

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

See also

• Foam::topoSetSource

Source files

• searchableSurfaceToFaceZone.H
• searchableSurfaceToFaceZone.C

Definition at line 156 of file searchableSurfaceToFaceZone.H.

Constructor & Destructor Documentation

searchableSurfaceToFaceZone() [1/2]

searchableSurfaceToFaceZone	(	const word &	surfaceType,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

Definition at line 96 of file searchableSurfaceToFaceZone.C.

searchableSurfaceToFaceZone() [2/2]

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

Definition at line 124 of file searchableSurfaceToFaceZone.C.

~searchableSurfaceToFaceZone()

virtual ~searchableSurfaceToFaceZone ( )

virtualdefault

Member Function Documentation

getSurfaceName()

Foam::word getSurfaceName ( const dictionary &  dict, const word &  defaultName  )

staticprotected

Definition at line 70 of file searchableSurfaceToFaceZone.C.

References dict.

TypeName()

TypeName

(

"searchableSurfaceToFaceZone"

)

applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 141 of file searchableSurfaceToFaceZone.C.

References faceZoneSet::addressing(), DynamicList::append(), stdFoam::end(), Foam::endl(), faceZoneSet::flipMap(), forAll, topoSet::found(), Foam::Info, 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/searchableSurfaceToFaceZone/searchableSurfaceToFaceZone.H
• src/meshTools/sets/faceZoneSources/searchableSurfaceToFaceZone/searchableSurfaceToFaceZone.C