patchToCell

Table of Contents

• Description
  • Operands
  • Notes on entries
• Further information

Description

A topoSetCellSource to select cells associated with given patch(es).

Operands

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

Description

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

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

    // Mandatory entries
    source      patchToCell;

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

    // Option-1
    patches
    (
        <patchName1>
        <patchName2>
        ...
    );

    // Option-2
    patch    <patchName>;
}

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: patchToCell	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
patches  | Names of patches         | wordList | conditional | -
patch    | Name of patch            | word     | conditional | -

Notes on entries

The order of precedence among the conditional mandatory entries from the highest to the lowest is patches, and patch.

Further information

Tutorial:

• $FOAM_TUTORIALS/incompressible/pisoFoam/RAS/cavity

Source code:

• Foam::patchToCell

History

• Introduced in version v1812

---

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