diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleCollector/ParticleCollector.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleCollector/ParticleCollector.H index 84db475552..2f6faea6b5 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleCollector/ParticleCollector.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleCollector/ParticleCollector.H @@ -26,9 +26,60 @@ Class Description Function object to collect the parcel mass- and mass flow rate over a - set of polygons. The polygons are defined as lists of points. If a - parcel is 'collected', it is subsequently flagged to be removed from the - domain. + set of polygons. The polygons can either be specified by sets of user- + supplied points, or in a concentric circles arrangement. If a + parcel is 'collected', it can be flagged to be removed from the + domain using the removeCollected entry. + + Example usage: + \verbatim + particleCollector1 + { + type particleCollector; + + mode concentricCircle; + origin (0.05 0.025 0.005); + radius (0.01 0.025 0.05); + nSector 10; + refDir (1 0 0); + normal (0 0 1); + + negateParcelsOppositeNormal no; + removeCollected no; + surfaceFormat vtk; + resetOnWrite no; + log yes; + } + + particleCollector2 + { + type particleCollector; + + mode polygon; + polygons + ( + ( + (0 0 0) + (1 0 0) + (1 1 0) + (0 1 0) + ) + ( + (0 0 1) + (1 0 1) + (1 1 1) + (0 1 1) + ) + ); + normal (0 0 1); + + negateParcelsOppositeNormal no; + removeCollected no; + surfaceFormat vtk; + resetOnWrite no; + log yes; + } + \endverbatim SourceFiles ParticleCollector.C