boxToCell

Table of Contents

Description

A topoSetCellSource to select all cells whose cell centre inside given bounding box(es).

Operands

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

Description

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

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

    // Mandatory entries
    source      boxToCell;

    // 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 cellSet word yes -
type Type name: cellSet word yes -
action Action applied on cells - see below word yes -
source Source name: boxToCell 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       | 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::boxToCell

History

  • Introduced in version 2.0
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