A topoSetCellSource to select cells attached to the outside of this cellSet, and add into/remove from this cellSet. More...

Inheritance diagram for haloToCell:

[legend]

Collaboration diagram for haloToCell:

[legend]

Public Member Functions
	TypeName ("haloToCell")

	haloToCell (const polyMesh &mesh, const label nsteps=1)

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

	haloToCell (const polyMesh &mesh, Istream &is)

virtual	~haloToCell ()=default

label	steps () const noexcept

label	steps (const label nsteps) noexcept

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
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 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 attached to the outside of this cellSet, and add into/remove from this cellSet.

Operands:

Operand	Type	Location
`input`	cellSet	$FOAM_CASE/constant/polyMesh/sets/<set>
`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      haloToCell;

    // Optional entries
    steps       1;
}

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: haloToCell	word	yes	-
`steps`	Number of grow/shrink steps to use	label	no	1

Options for the action entry:

      add      | Add selected cells into this cellSet
      subtract | Remove selected cells from this cellSet

Note

action=new is not available for haloToCell.
When removing halo cells, this strips off any cells on the boundary of the cellSet.

See also

Source files

Definition at line 144 of file haloToCell.H.

Constructor & Destructor Documentation

◆ haloToCell() [1/3]

haloToCell	(	const polyMesh &	mesh,
		const label	nsteps = `1`
	)

explicit

Definition at line 176 of file haloToCell.C.

◆ haloToCell() [2/3]

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

Definition at line 187 of file haloToCell.C.

◆ haloToCell() [3/3]

haloToCell	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 197 of file haloToCell.C.

◆ ~haloToCell()

virtual ~haloToCell ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "haloToCell" )

◆ steps() [1/2]

Foam::label steps ( ) const

noexcept

Definition at line 208 of file haloToCell.C.

◆ steps() [2/2]

Foam::label steps ( const label nsteps )

noexcept

Definition at line 214 of file haloToCell.C.

◆ applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 223 of file haloToCell.C.

References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::endl(), Foam::Info, topoSetSource::NEW, Foam::nl, 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/haloToCell/haloToCell.H
src/meshTools/sets/cellSources/haloToCell/haloToCell.C

Public Member Functions

Additional Inherited Members