Commit Graph

19 Commits

Author SHA1 Message Date
Kenneth Moreland
282aa82957 Add guide chapter on working with cells 2024-03-13 09:18:33 -04:00
Kenneth Moreland
28683930e3 Updated constructors for mesh info classes to conform with other filters
The `CellMeasures` and `MeshQuality` filters had constructors that took the
metric that the filter should generate. However, this is different than the
iterface of the rest of the filters. To make the interface more consistent,
these filters now have a default (no argument) constructor, and the metric
to compute is selected via a method. This makes it more clear what is being
done.

In addition, the documentation for these two classes is updated.
2024-03-07 20:47:09 -05:00
Kenneth Moreland
2fe05097eb Add continued filter implementation chapter 2024-02-28 12:51:07 -05:00
Kenneth Moreland
e9ba5bf8c7 Add math section to users guide 2024-02-20 11:03:04 +09:00
Kenneth Moreland
97269b9860 Fix documentation for methods from FilterField
MR !3195 moved methods from `FilterField` to `Filter`. Needed to update
the documentation to do this as well.
2024-02-16 20:38:53 +09:00
Kenneth Moreland
eba02710de Merge topic 'deprecate-filter-field'
a17ebdf52 Deprecated `vtkm::filter::FilterField`

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Li-Ta Lo <ollie@lanl.gov>
Merge-request: !3195
2024-02-14 19:05:25 -05:00
Vicente Adolfo Bolea Sanchez
d5a90cba1e update readthedocs-sphinx-search 2024-02-14 12:03:42 -05:00
Kenneth Moreland
05dbd670b3 Add worklet error handling section to users guide 2024-02-13 08:42:04 +09:00
Kenneth Moreland
a17ebdf52a Deprecated vtkm::filter::FilterField
The original design of the filter base class required several specialized
base classes to control what information was pulled from the input
`DataSet` and provided to the derived class. Since the filter base class was
redesigned, the derived classes all get a `DataSet` and pull their own
information from it. Thus, most specialized filter base classes became
unnecessary and removed.

The one substantial exception was the `FilterField`. This filter base class
managed input and output arrays. This was kept separate from the base
`Filter` because not all filters need the ability to select this
information.

That said, this separation has not been particularly helpful. There are
several other features of `Filter` that does not apply to all subclasses.
Furthermore, there are several derived filters that are using `FilterField`
merely to pick a single part, like selecting a coordinate system, and
ignoring the rest of the abilities.

Thus, it makes more sense to deprecate `FilterField` and have these classes
inherit directly from `Filter`.
2024-02-12 08:13:19 +09:00
Kenneth Moreland
fa2eb79b07 Merge topic 'guide-worklet-types'
3b1bfa0cd Add reference documentation for Worklet types

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Vicente Bolea <vicente.bolea@kitware.com>
Merge-request: !3184
2024-02-08 16:05:26 -05:00
Kenneth Moreland
9c42db5c71 Fix sphinx/breathe warning about function reference
The breathe parser was having trouble with using `{}` inside of a
declspec for the return value. Replace this with parenthesis, which
cannot be confused with the openning of the function.
2024-02-08 10:39:46 -05:00
Kenneth Moreland
3b1bfa0cdd Add reference documentation for Worklet types 2024-01-29 12:26:08 -05:00
Kenneth Moreland
b1b6cb65c0 Add documentation of logging 2024-01-04 15:25:07 -05:00
Kenneth Moreland
f1e3bed044 Add advanced types chapter to user's guide 2023-12-18 14:22:40 -07:00
Kenneth Moreland
cba1068bec Update the developing algorithms section of the user's guide 2023-12-08 08:50:18 -05:00
Kenneth Moreland
45ad2fb50d Add documentation of MergeDataSets filter to user's guide 2023-11-30 18:36:29 -05:00
Kenneth Moreland
5b8c282e9f Continue transfer of Users' Guide text
These changes complete the using part of the guide.
2023-11-21 10:33:45 -07:00
Kenneth Moreland
b261d23876 Allow turning off todo notes in user's guide 2023-10-24 15:47:17 +11:00
Kenneth Moreland
b80b7e2e71 Add VTK-m User's Guide to source
This is a start of moving the VTK-m User's Guide into the VTK-m source.
This is only the start of the process. There are several goals of this
work.

1. Integrate the documentation into the source code better to better
   keep the code up to date.
2. Move the documentation over to Sphinx so that it can be posted online
   and be more easily linked.
3. Incoporate Doxygen into the guide to keep the documentation
   consistent.
4. Build the user guide examples as part of the VTK-m CI to catch
   compatibility changes quickly.
2023-10-17 11:31:27 -04:00