Selection of parcels based on their objectRegistry entries. Normally accessed via a dictionary entry. More...

#include <parcelSelectionDetail.H>

Inheritance diagram for parcelSelection:

[legend]

Collaboration diagram for parcelSelection:

[legend]

Public Types
enum	actionType { ALL , CLEAR , INVERT , ADD , SUBTRACT , SUBSET , USE , IGNORE }
	Enumeration defining the valid selection actions. More...
enum	sourceType { FIELD , STRIDE }
	Enumeration defining the valid sources. More...
enum	logicType { AND , OR }
	Enumeration defining and/or logic. More...

Public Member Functions
	parcelSelection ()=default
	Default construct.
virtual	~parcelSelection ()=default
	Destructor.

Static Public Attributes
static const Enum< actionType >	actionNames
	Names for the actionType.
static const Enum< sourceType >	sourceNames
	Names for the sourceType.
static const Enum< logicType >	logicNames
	Names for the logicType.

Protected Member Functions
bool	calculateFilter (const objectRegistry &obrTmp, const bool log=true)
	Calculate parcel selection filter.

Protected Attributes
dictionary	parcelSelect_
	The filtered parcel addressing. Eg, for the current cloud.
bitSet	parcelAddr_
	The filtered parcel addressing. Eg, for the current cloud.

Detailed Description

Selection of parcels based on their objectRegistry entries. Normally accessed via a dictionary entry.

Example sub-dictionary entry

selection
{
    stride
    {
        // every 10th parcelId
        action  use;
        source  stride;
        stride  10;
    }
    injector
    {
        // Only output from injectorID == 1
        action  subset;
        source  field;
        field   typeId;
        accept  (equal 1);
    }
    Umin
    {
        // Remove slow parcels
        action  subtract;
        source  field;
        field   U;
        accept  (less 1e-3);
    }
    diam
    {
        // Only particular diameter ranges
        action  subset;
        source  field;
        field   d;
        accept  (greater 1e-5) and (less 1e-3);
    }
}

Entry type

Property	Description	Required	Default
`action`	all/clear/invert/ignore add/subtract/subset/use	yes
`source`	field/stride	mostly

Stride source

Property	Description	Required	Default
`stride`	The stride for the parcel id	yes

Field source

Property	Description	Required	Default
`field`	The label/scalar/vector field name	yes
`accept`	Acceptance or test criterion	yes

The accept criterion has two forms:

single expression
- (expr)
composite expression
- (expr) or (expr)
- (expr) and (expr)

The expressions are a (op scalar) pair that form a unary scalar predicate. The op is one of the following:

lt, less
le, lessEqual, lessEq
gt, greater
ge, greaterEqual, greaterEq
eq, equal
neq, notEqual

For example,

    accept  (less 10);
    accept  (less 10) or (greater 100);
    accept  (ge 10) and (le 20);

See also: Foam::predicates::scalars Foam::functionObjects::vtkCloud

Source files

Definition at line 176 of file parcelSelectionDetail.H.

Member Enumeration Documentation

◆ actionType

enum actionType

Enumeration defining the valid selection actions.

Enumerator
ALL	"all" - select all parcels
CLEAR	"clear" - clear the selection
INVERT	"invert" - invert the selection
ADD	"add" - parcel selection
SUBTRACT	"subtract" - remove parcel selection
SUBSET	"subset" - subset parcel selection
USE	"use" - same as clear + add
IGNORE	"ignore" - dummy no-op