A topoSetCellSource to select all the cells from given cellSet(s). More...

Inheritance diagram for cellToCell:

Collaboration diagram for cellToCell:

Public Member Functions
	TypeName ("cellToCell")

	cellToCell (const polyMesh &mesh, const word &setName)

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

	cellToCell (const polyMesh &mesh, Istream &is)

virtual	~cellToCell ()=default

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 all the cells from given cellSet(s).

Operands:

Operand	Type	Location
`input`	cellSet(s)	$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      cellToCell;

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

    // Option-1
    sets
    (
        <cellSetName1>
        <cellSetName2>
        ...
    );

    // Option-2
    set <cellSetName>;
}

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: cellToCell	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 conditional mandatory entries:

      Entry    | Description                    | Type     | Req'd  | Dflt
      sets     | Names of input cellSets        | wordList | cond'l | -
      set      | Name of input cellSet          | word     | cond'l | -

Note: The order of precedence among the conditional mandatory entries from the highest to the lowest is sets, and set.

See also

Source files

Definition at line 155 of file cellToCell.H.

Constructor & Destructor Documentation

◆ cellToCell() [1/3]

cellToCell	(	const polyMesh &	mesh,
		const word &	setName
	)

Definition at line 50 of file cellToCell.C.

◆ cellToCell() [2/3]

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

Definition at line 61 of file cellToCell.C.

References dict.

◆ cellToCell() [3/3]

cellToCell	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 79 of file cellToCell.C.

◆ ~cellToCell()

virtual ~cellToCell ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "cellToCell" )

◆ applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 92 of file cellToCell.C.

References Foam::flatOutput(), Foam::Info, Foam::nl, and Foam::BitOps::set().

Here is the call graph for this function:

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

src/meshTools/sets/cellSources/cellToCell/cellToCell.H
src/meshTools/sets/cellSources/cellToCell/cellToCell.C

Public Member Functions

Additional Inherited Members