cellToPoint

Table of Contents

Description

A topoSetPointSource to select all the points from given cellSet(s).

Operands

Operand Type Location
input cellSet(s) $FOAM_CASE/constant/polyMesh/sets/<set>
output pointSet $FOAM_CASE/constant/polyMesh/sets/<set>

Description

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

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

    // Mandatory entries
    source      cellToPoint;
    option      <option>;

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

    // Option-1
    sets
    (
        <pointSetName1>
        <pointSetName2>
        ...
    );

    // Option-2 
    set <pointSetName>;
}

where the entries mean:

Property Description Type Required Default
name Name of pointSet word yes -
type Type name: pointSet word yes -
action Action applied on points - see below word yes -
source Source name: cellToPoint word yes -

Options for the action entry: 

new      | Create a new pointSet from selected points
add      | Add selected points into this pointSet
subtract | Remove selected points from this pointSet

Options for the option entry: 

all      | Select all points of cells in the cellSet

Options for the conditional mandatory entries: 

Entry    | Description                    | Type     | Required    | Default
sets     | Names of input pointSets       | wordList | conditional | -
set      | Name of input pointSet         | word     | conditional | -

Notes on entries

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

Further information

Tutorial:

Source code:

  • Foam::cellToPoint

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