Shuenhoy/vtk-m2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more doc on the selection of scalar field and DivideByVolume

Browse Source
This commit is contained in:
Li-Ta Lo 2021-03-17 08:00:35 -06:00
parent ff73723f51
commit d25eb7de7e
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
vtkm/filter/ParticleDensityNearestGridPoint.h
View File

@ -23,6 +23,13 @@ namespace filter
/// such as charge). The filter estimates density by imposing a regular grid as
/// specified in the constructor and summing the mass of particles within each cell
/// in the grid.
/// The mass of particles is established by setting the active field (using SetActiveField).
/// Note that the "mass" can actually be another quantity. For example, you could use
/// electrical charge in place of mass to compute the charge density.
/// Once the sum of the mass is computed for each grid cell, the mass is divided by the
/// volume of the cell. Thus, the density will be computed as the units of the mass field
/// per the cubic units of the coordinate system. If you just want a sum of the mass in each
/// cell, turn off the DivideByVolume feature of this filter.
// We only need the CoordinateSystem and scalar fields of the input dataset thus a FilterField
class ParticleDensityNearestGridPoint