Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
parcelSelection Class Reference

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

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 ()
 Construct null. More...
 
virtual ~parcelSelection ()=default
 Destructor. More...
 

Static Public Attributes

static const Enum< actionType > actionNames
 Names for the actionType. More...
 
static const Enum< sourceType > sourceNames
 Names for the sourceType. More...
 
static const Enum< logicType > logicNames
 Names for the logicType. More...
 

Protected Member Functions

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

Protected Attributes

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

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:

  1. single expression
    • (expr)
  2. 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, lessEq
  • gt, greater
  • ge, 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 180 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

Definition at line 185 of file parcelSelectionDetail.H.

◆ sourceType

enum sourceType

Enumeration defining the valid sources.

Enumerator
FIELD 

"field" - select based on field value

STRIDE 

"stride" - select based on stride (parcel id)

Definition at line 202 of file parcelSelectionDetail.H.

◆ logicType

enum logicType

Enumeration defining and/or logic.

Enumerator
AND 
OR 

Definition at line 213 of file parcelSelectionDetail.H.

Constructor & Destructor Documentation

◆ parcelSelection()

parcelSelection ( )

Construct null.

Definition at line 149 of file parcelSelectionDetail.C.

◆ ~parcelSelection()

virtual ~parcelSelection ( )
virtualdefault

Destructor.

Member Function Documentation

◆ calculateFilter()

bool calculateFilter ( const objectRegistry &  obrTmp,
const bool  log = true 
)
protected

Calculate parcel selection filter.

Returns
True if the filter is applicable

Definition at line 159 of file parcelSelectionDetail.C.

References Foam::actionNames, scalars::andOp(), Foam::apply(), dict, Foam::constant::electromagnetic::e, Foam::endl(), cloud::findIOPosition(), objectRegistry::findObject(), keyType::LITERAL, Log, objectRegistry::lookupObject(), Foam::mag(), Foam::nl, scalars::operation(), scalars::orOp(), Foam::reduce(), and WarningInFunction.

Here is the call graph for this function:

Member Data Documentation

◆ actionNames

const Foam::Enum< Foam::Detail::parcelSelection::actionType > actionNames
static

Names for the actionType.

Definition at line 198 of file parcelSelectionDetail.H.

◆ sourceNames

const Foam::Enum< Foam::Detail::parcelSelection::sourceType > sourceNames
static

Names for the sourceType.

Definition at line 209 of file parcelSelectionDetail.H.

◆ logicNames

const Foam::Enum< Foam::Detail::parcelSelection::logicType > logicNames
static

Names for the logicType.

Definition at line 216 of file parcelSelectionDetail.H.

◆ parcelSelect_

dictionary parcelSelect_
protected

The filtered parcel addressing. Eg, for the current cloud.

Definition at line 224 of file parcelSelectionDetail.H.

◆ parcelAddr_

bitSet parcelAddr_
protected

The filtered parcel addressing. Eg, for the current cloud.

Definition at line 227 of file parcelSelectionDetail.H.

The documentation for this class was generated from the following files: