A topoSetCellSource to select cells based on relation to a surface given by an external file. More...

Inheritance diagram for surfaceToCell:

Collaboration diagram for surfaceToCell:

Public Member Functions
	TypeName ("surfaceToCell")

	surfaceToCell (const polyMesh &mesh, const fileName &surfName, const pointField &outsidePoints, const bool includeCut, const bool includeInside, const bool includeOutside, const bool useSurfaceOrientation, const scalar nearDist, const scalar curvature)

	surfaceToCell (const polyMesh &mesh, const fileName &surfName, const triSurface &surf, const triSurfaceSearch &querySurf, const pointField &outsidePoints, const bool includeCut, const bool includeInside, const bool includeOutside, const bool useSurfaceOrientation, const scalar nearDist, const scalar curvature)

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

	surfaceToCell (const polyMesh &mesh, Istream &is)

virtual	~surfaceToCell ()

virtual void	applyToSet (const topoSetSource::setAction action, topoSet &) 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 based on relation to a surface given by an external file.

surfaceToCell can select:

all cells inside/outside/cut by a surface
all cells inside/outside surface (useSurfaceOrientation, requires closed surface)
cells with centre nearer than XXX to surface
cells with centre nearer than XXX to surface and with normal at nearest point to centre and cell-corners differing by more than YYY (i.e. point of high curvature)

Operands:

Operand	Type	Location
`input`	triSurface	$FOAM_CASE/constant/triSurface/<file>
`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          surfaceToCell;
    file            <surfaceFileName>;
    outsidePoints
    (
        (<p1x> <p1y> <p1z>)
        (<p2x> <p2y> <p2z>)
        ...
    );
    includeCut      false;
    includeInside   false;
    includeOutside  true;
    nearDistance    0.5;
    curvature       1.0;

    // Optional entries
    useSurfaceOrientation false;
    fileType        stl;
    scale           2.0;
}

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: surfaceToCell	word	yes	-
`file`	The surface "filename"	word	yes	-
`outsidePoints`	List of points that define outside of the surface	vectorList	yes	-
`includeCut`	Flag to include cut cells	bool	yes	-
`includeInside`	Flag to include inside cells	bool	yes	-
`includeOutside`	Flag to include outside cells	bool	yes	-
`useSurfaceOrientation`	Flag to use inherently the orientation of the surface	bool	no	false
`nearDistance`	Near distance to the surface	scalar	yes	-
`curvature`	Surface curvature	scalar	yes	-
`fileType`	The format of the surface file	word	no	""
`scale`	Surface scaling factor	scalar	no	-1

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

See also

Source files

Definition at line 238 of file surfaceToCell.H.

Constructor & Destructor Documentation

◆ surfaceToCell() [1/4]

surfaceToCell	(	const polyMesh &	mesh,
		const fileName &	surfName,
		const pointField &	outsidePoints,
		const bool	includeCut,
		const bool	includeInside,
		const bool	includeOutside,
		const bool	useSurfaceOrientation,
		const scalar	nearDist,
		const scalar	curvature
	)

Definition at line 362 of file surfaceToCell.C.

◆ surfaceToCell() [2/4]

surfaceToCell	(	const polyMesh &	mesh,
		const fileName &	surfName,
		const triSurface &	surf,
		const triSurfaceSearch &	querySurf,
		const pointField &	outsidePoints,
		const bool	includeCut,
		const bool	includeInside,
		const bool	includeOutside,
		const bool	useSurfaceOrientation,
		const scalar	nearDist,
		const scalar	curvature
	)