Loading...
Searching...
No Matches
collector Class Reference

Implementation of template-invariant tools for various function objects such as Foam::ParticleHistogram. More...

#include <cloudFunctionObjectTools.H>

Public Member Functions

 collector (const dictionary &dict, const polyMesh &mesh)
 Construct from dictionary.
 collector (const collector &phc)
 Copy construct.
void operator= (const collector &)=delete
 No copy assignment.
virtual ~collector ()=default
 Destructor.
bool isPatch () const noexcept
 Return the flag if the collector is patch based.
label size () const noexcept
 Return number of collectors (zones or patches).
const labelList & IDs () const noexcept
 Return const reference to the indices of collectors.
const wordList & names () const noexcept
 Return const reference to the names of collectors.
const List< boundBox > & BBs () const noexcept
 Return const reference to the bounding-boxes of collectors.

Detailed Description

Implementation of template-invariant tools for various function objects such as Foam::ParticleHistogram.

Source files

Definition at line 55 of file cloudFunctionObjectTools.H.

Constructor & Destructor Documentation

◆ collector() [1/2]

collector ( const dictionary & dict,
const polyMesh & mesh )

Construct from dictionary.

Definition at line 25 of file cloudFunctionObjectTools.C.

References dict, UList< T >::empty(), and mesh.

Referenced by collector(), and operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ collector() [2/2]

collector ( const collector & phc)

Copy construct.

Definition at line 94 of file cloudFunctionObjectTools.C.

References collector().

Here is the call graph for this function:

◆ ~collector()

virtual ~collector ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const collector & )
delete

No copy assignment.

References collector().

Here is the call graph for this function:

◆ isPatch()

bool isPatch ( ) const
inlinenoexcept

Return the flag if the collector is patch based.

Definition at line 117 of file cloudFunctionObjectTools.H.

References Foam::noexcept.

◆ size()

label size ( ) const
inlinenoexcept

Return number of collectors (zones or patches).

Definition at line 122 of file cloudFunctionObjectTools.H.

References Foam::noexcept.

◆ IDs()

const labelList & IDs ( ) const
inlinenoexcept

Return const reference to the indices of collectors.

Definition at line 127 of file cloudFunctionObjectTools.H.

References Foam::noexcept.

◆ names()

const wordList & names ( ) const
inlinenoexcept

Return const reference to the names of collectors.

Definition at line 132 of file cloudFunctionObjectTools.H.

References Foam::noexcept.

◆ BBs()

const List< boundBox > & BBs ( ) const
inlinenoexcept

Return const reference to the bounding-boxes of collectors.

Definition at line 137 of file cloudFunctionObjectTools.H.

References Foam::noexcept.

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