boxToFace

Table of Contents

Description

A topoSetFaceSource to select all faces whose face centre inside given bounding box(es).

Operands

Operand Type Location
output faceSet $FOAM_CASE/constant/polyMesh/sets/<set>

Description

Example of the boxToFace topoSet by using actions sub-dictionary in system/topoSetDict file: 

{
    // Mandatory (inherited) entries
    name        <name>;
    type        faceSet;
    action      <action>;

    // Mandatory entries
    source      boxToFace;

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

    // Option-1
    boxes
    (
        (<minX> <minY> <minZ>) (<maxX> <maxY> <maxZ>) // box-1
        (<minX> <minY> <minZ>) (<maxX> <maxY> <maxZ>) // box-2
        ...
    );

    // Option-2 
    box (<minX> <minY> <minZ>) (<maxX> <maxY> <maxZ>);

    // Option-3
    min (<minX> <minY> <minZ>);
    max (<maxX> <maxY> <maxZ>);
}

where the entries mean:

Property Description Type Required Default
name Name of faceSet word yes -
type Type name: faceSet word yes -
action Action applied on faces - see below word yes -
source Source name: boxToFace word yes -

Options for the action entry: 

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

Options for the conditional mandatory entries: 

Entry    | Description                    | Type       | Required    | Default
boxes    | Multiple bounding boxes        | vectorList | conditional | -
box      | A single bounding box          | vector     | conditional | -
min      | Minimum point for a single box | vector     | conditional | -
max      | Maximum point for a single box | vector     | conditional | -

Notes on entries

The order of precedence among the conditional mandatory entries from the highest to the lowest is boxes, box or a min-max pair (compatibility with searchableBox).

Further information

Tutorial:

Source code:

  • Foam::boxToFace

History

  • Introduced in version 1.5
Would you like to suggest an improvement to this page? Create an issue

Copyright © 2020 OpenCFD Ltd.

Licensed under the Creative Commons License BY-NC-ND Creative Commons License