From c04eb3042da56db3bbbce42301e9a7903353e282 Mon Sep 17 00:00:00 2001 From: Spiros Tsalikis Date: Fri, 17 Jan 2025 12:16:23 -0500 Subject: [PATCH] Add documentation about state/metadata/vtk_fields node --- doc/source/Catalyst/blueprints.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/doc/source/Catalyst/blueprints.rst b/doc/source/Catalyst/blueprints.rst index 50f67e5..a1383c0 100644 --- a/doc/source/Catalyst/blueprints.rst +++ b/doc/source/Catalyst/blueprints.rst @@ -153,6 +153,35 @@ The ``channel`` protocol is as follows: In ParaView Catalyst, the each field will be added as a Field Data array to the generated VTK object. +- ``channel/data/metadata/vtk_fields/[field-name]``: (optional) defines + metadata for a specific field named `[field-name]` so that it can be + utilized appropriately by VTK (see `CxxPolygonalWithAttributes example `_). These metadata are: + + 1. ``attribute_type```: It is a string and represents the attribute type of a field + so that VTK can use an attribute array, such as `GlobalIds`. The values used + are the entries of `vtkDataSetAttributes::AttributeTypes` + `Ghosts`. + The complete list of values is: + + - `Scalars` + - `Vectors` + - `Normals` + - `TCoords` + - `Tensors` + - `GlobalIds` + - `PedigreeIds` + - `EdgeFlag` + - `Tangents` + - `RationalWeights` + - `HigherOrderDegrees` + - `ProcessIds` + - `Ghosts` + + 2. ``values_to_replace`` and ``replacement_values``: These two are vectors of values that be used to replace specific + values in the field. This is useful when the field has some values that are not valid for VTK. For example, + the `vtkGhostType` array uses specific values that other ghost cell generator algorithms may not use. + In this case, the ``values_to_replace`` would be the values that need to be replaced, and the + ``replacement_values`` would be the values that should replace them. The two vectors should have the same length. + - ``channel/state``: (optional) fields to optionally override the ``catalyst/state`` temporal information. -- GitLab