collector Class Reference

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

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

Detailed Description

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

Source files

• cloudFunctionObjectTools.H
• cloudFunctionObjectTools.C

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 26 of file cloudFunctionObjectTools.C.

References Foam::BitOps::count(), dict, UList< T >::empty(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::flatOutput(), ZoneMesh< ZoneType, MeshType >::indices(), mesh, zoneIdentifier::name(), Foam::nl, points, and List< T >::resize().

Here is the call graph for this function:

collector() [2/2]

collector

(

const collector &

phc

)

Copy construct.

Definition at line 95 of file cloudFunctionObjectTools.C.

~collector()

virtual ~collector ( )

virtualdefault

Destructor.

Member Function Documentation

operator=()

void operator= ( const collector &  )

delete

No copy assignment.

isPatch()

bool isPatch ( ) const

inlinenoexcept

Return the flag if the collector is patch based.

Definition at line 117 of file cloudFunctionObjectTools.H.

size()

label size ( ) const

inlinenoexcept

Return number of collectors (zones or patches)

Definition at line 122 of file cloudFunctionObjectTools.H.

References UList< T >::size().

Here is the call graph for this function:

IDs()

const labelList& IDs ( ) const

inlinenoexcept

Return const reference to the indices of collectors.

Definition at line 127 of file cloudFunctionObjectTools.H.

names()

const wordList& names ( ) const

inlinenoexcept

Return const reference to the names of collectors.

Definition at line 132 of file cloudFunctionObjectTools.H.

BBs()

const List<boundBox>& BBs ( ) const

inlinenoexcept

Return const reference to the bounding-boxes of collectors.

Definition at line 137 of file cloudFunctionObjectTools.H.

---

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

• src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObject/cloudFunctionObjectTools.H
• src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObject/cloudFunctionObjectTools.C