ENH: topoSet: added comment

This commit is contained in:
mattijs 2022-04-14 09:05:00 +01:00
parent 02b8862de7
commit 2336e4a4e6
2 changed files with 7 additions and 1 deletions

View File

@ -363,7 +363,9 @@ faceSet_doc
}
//- Select faces with centres within a searchableSurface
//- Select faces with centres within a (closed!) searchableSurface
// (if surface is not closed a warning will be given and surface will
// be ignored)
{
source searchableSurfaceToFace;
surfaceType triSurfaceMesh; // The surface type

View File

@ -30,6 +30,10 @@ Description
A \c topoSetFaceSource to select faces whose face
centre enclosed by a given \c searchableSurface.
The surface has to be closed - if not a warning will be given:
"The surface XXX appears to be unclosed ... ignoring" and the surface
will not be used.
Operands:
\table
Operand | Type | Location