Skip to content

Commit f7eb7bc

Browse files
committed
automatic update
1 parent b26bffd commit f7eb7bc

122 files changed

Lines changed: 2818 additions & 132 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/module/all.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ All Modules
1919

2020
:doc:`ApplyTransform <geometry/ApplyTransform/ApplyTransform>` (:doc:`Geometry <geometry/index>`) *compute transformed coordinates*
2121

22+
:doc:`ApplyTransformVtkm <geometry/ApplyTransformVtkm/ApplyTransformVtkm>` (:doc:`Geometry <geometry/index>`) *compute transformed coordinates*
23+
2224
:doc:`Assemble <general/Assemble/Assemble>` (:doc:`General <general/index>`) *assemble blocks of indexed geometry to larger blocks*
2325

2426
:doc:`AttachGrid <general/AttachGrid/AttachGrid>` (:doc:`General <general/index>`) *attach underlying grid to mappable data*
@@ -31,7 +33,7 @@ All Modules
3133
**B**
3234
:doc:`BlenderRenderer <render/BlenderRenderer/BlenderRenderer>` (:doc:`Render <render/index>`) *Blender remote renderer*
3335

34-
:doc:`BoundingBox <map/BoundingBox/BoundingBox>` (:doc:`Map <map/index>`) *compute bounding boxes*
36+
:doc:`BoundingBox <map/BoundingBox/BoundingBox>` (:doc:`Map <map/index>`) *compute axis-aligned bounding boxes*
3537

3638

3739
**C**

docs/module/develop/CreateCelltree/CreateCelltree.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,21 @@ create a cell tree
1818
<text x="1.9em" y="5.8999999999999995em" class="text" >output grid<tspan> (grid_out)</tspan></text>
1919
</svg>
2020

21+
## Parameters
22+
23+
24+
:::{admonition} Supported System Parameters
25+
:class: dropdown
26+
27+
|name|description|type|
28+
|-|-|-|
29+
|[_openmp_threads](../../system-parameters.md#_openmp_threads)|number of OpenMP threads (0: system default)|Int|
30+
|[_benchmark](../../system-parameters.md#_benchmark)|show timing information|Int|
31+
|[_concurrency](../../system-parameters.md#_concurrency)|number of tasks to keep in flight per MPI rank (-1: #cores/2)|Int|
32+
|[_cache_mode](../../system-parameters.md#_cache_mode)|input object caching (CacheNone, CacheDeleteEarly, CacheDeleteLate, CacheByName)|Int|
33+
|[_prioritize_visible](../../system-parameters.md#_prioritize_visible)|prioritize currently visible timestep|Int|
34+
|[_validate_objects](../../system-parameters.md#_validate_objects)|validate data objects before sending to port (Disable, Quick, Thorough)|Int|
35+
36+
The meaning of these parameters is described in more detail in the [System Parameters](../../system-parameters.md) documentation.
37+
:::
38+

docs/module/develop/CreateVertexOwnerList/CreateVertexOwnerList.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,21 @@ create vertex owner list
1818
<text x="1.9em" y="5.8999999999999995em" class="text" >output grid<tspan> (grid_out)</tspan></text>
1919
</svg>
2020

21+
## Parameters
22+
23+
24+
:::{admonition} Supported System Parameters
25+
:class: dropdown
26+
27+
|name|description|type|
28+
|-|-|-|
29+
|[_openmp_threads](../../system-parameters.md#_openmp_threads)|number of OpenMP threads (0: system default)|Int|
30+
|[_benchmark](../../system-parameters.md#_benchmark)|show timing information|Int|
31+
|[_concurrency](../../system-parameters.md#_concurrency)|number of tasks to keep in flight per MPI rank (-1: #cores/2)|Int|
32+
|[_cache_mode](../../system-parameters.md#_cache_mode)|input object caching (CacheNone, CacheDeleteEarly, CacheDeleteLate, CacheByName)|Int|
33+
|[_prioritize_visible](../../system-parameters.md#_prioritize_visible)|prioritize currently visible timestep|Int|
34+
|[_validate_objects](../../system-parameters.md#_validate_objects)|validate data objects before sending to port (Disable, Quick, Thorough)|Int|
35+
36+
The meaning of these parameters is described in more detail in the [System Parameters](../../system-parameters.md) documentation.
37+
:::
38+

docs/module/develop/Dropbear/Dropbear.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ start Dropbear SSH server on compute nodes
99
<text x="0.2em" y="2.6500000000000004em" class="moduleName" >Dropbear</text></svg>
1010

1111
## Parameters
12+
13+
1214
|name|description|type|
1315
|-|-|-|
1416
|dropbear_path|pathname to dropbear binary|String|
@@ -19,3 +21,17 @@ start Dropbear SSH server on compute nodes
1921
|hostkey_ecdsa|path to ecdsa host key (~/.ssh/vistle_dropbear_ecdsa)|String|
2022
|exposed_rank|rank to expose on hub (-1: none)|Int|
2123
|exposed_port|port to which exposed rank's dropbear should be forwarded to on hub (<=0: absolute value used as offset to dropbear port)|Int|
24+
25+
26+
:::{admonition} Supported System Parameters
27+
:class: dropdown
28+
29+
|name|description|type|
30+
|-|-|-|
31+
|[_openmp_threads](../../system-parameters.md#_openmp_threads)|number of OpenMP threads (0: system default)|Int|
32+
|[_benchmark](../../system-parameters.md#_benchmark)|show timing information|Int|
33+
|[_concurrency](../../system-parameters.md#_concurrency)|number of tasks to keep in flight per MPI rank (-1: #cores/2)|Int|
34+
35+
The meaning of these parameters is described in more detail in the [System Parameters](../../system-parameters.md) documentation.
36+
:::
37+

docs/module/develop/FilterNode/FilterNode.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,27 @@ filter data objects
1919
</svg>
2020

2121
## Parameters
22+
23+
2224
|name|description|type|
2325
|-|-|-|
2426
|criterion|Selection criterion (Rank, BlockNumber, Timestep)|Int|
2527
|selection|Number of MPI rank, block, timestep to select|Int|
2628
|invert|Invert block selection|Int|
29+
30+
31+
:::{admonition} Supported System Parameters
32+
:class: dropdown
33+
34+
|name|description|type|
35+
|-|-|-|
36+
|[_openmp_threads](../../system-parameters.md#_openmp_threads)|number of OpenMP threads (0: system default)|Int|
37+
|[_benchmark](../../system-parameters.md#_benchmark)|show timing information|Int|
38+
|[_concurrency](../../system-parameters.md#_concurrency)|number of tasks to keep in flight per MPI rank (-1: #cores/2)|Int|
39+
|[_cache_mode](../../system-parameters.md#_cache_mode)|input object caching (CacheNone, CacheDeleteEarly, CacheDeleteLate, CacheByName)|Int|
40+
|[_prioritize_visible](../../system-parameters.md#_prioritize_visible)|prioritize currently visible timestep|Int|
41+
|[_validate_objects](../../system-parameters.md#_validate_objects)|validate data objects before sending to port (Disable, Quick, Thorough)|Int|
42+
43+
The meaning of these parameters is described in more detail in the [System Parameters](../../system-parameters.md) documentation.
44+
:::
45+

docs/module/develop/GenIsoDat/GenIsoDat.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,25 @@ generate test data for IsoSurface module
1919
</svg>
2020

2121
## Parameters
22+
23+
2224
|name|description|type|
2325
|-|-|-|
2426
|cell_type|type of cells (Tetrahedron, Pyramid, Prism, Hexahedron, Polyhedron)|Int|
2527
|case_num|case number (-1: all)|Int|
28+
29+
30+
:::{admonition} Supported System Parameters
31+
:class: dropdown
32+
33+
|name|description|type|
34+
|-|-|-|
35+
|[_openmp_threads](../../system-parameters.md#_openmp_threads)|number of OpenMP threads (0: system default)|Int|
36+
|[_benchmark](../../system-parameters.md#_benchmark)|show timing information|Int|
37+
|[_concurrency](../../system-parameters.md#_concurrency)|number of tasks to keep in flight per MPI rank (-1: #cores/2)|Int|
38+
|[_prioritize_visible](../../system-parameters.md#_prioritize_visible)|prioritize currently visible timestep|Int|
39+
|[_validate_objects](../../system-parameters.md#_validate_objects)|validate data objects before sending to port (Disable, Quick, Thorough)|Int|
40+
41+
The meaning of these parameters is described in more detail in the [System Parameters](../../system-parameters.md) documentation.
42+
:::
43+

docs/module/develop/GenNormalsVtkm/GenNormalsVtkm.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,29 @@ compute surface normals
1919
</svg>
2020

2121
## Parameters
22+
23+
2224
|name|description|type|
2325
|-|-|-|
2426
|per_vertex|interpolate per-vertex normals|Int|
2527
|normalize|normalize per-element normals|Int|
2628
|auto_orient|orient normals outward (requires closed surface)|Int|
2729
|inward|flip auto-oriented normals to point inward|Int|
30+
31+
32+
:::{admonition} Supported System Parameters
33+
:class: dropdown
34+
35+
|name|description|type|
36+
|-|-|-|
37+
|[_openmp_threads](../../system-parameters.md#_openmp_threads)|number of OpenMP threads (0: system default)|Int|
38+
|[_benchmark](../../system-parameters.md#_benchmark)|show timing information|Int|
39+
|[_concurrency](../../system-parameters.md#_concurrency)|number of tasks to keep in flight per MPI rank (-1: #cores/2)|Int|
40+
|[_cache_mode](../../system-parameters.md#_cache_mode)|input object caching (CacheNone, CacheDeleteEarly, CacheDeleteLate, CacheByName)|Int|
41+
|[_prioritize_visible](../../system-parameters.md#_prioritize_visible)|prioritize currently visible timestep|Int|
42+
|[_validate_objects](../../system-parameters.md#_validate_objects)|validate data objects before sending to port (Disable, Quick, Thorough)|Int|
43+
|[_print_object_info](../../system-parameters.md#_print_object_info)|print information on generated data objects for debug purposes|Int|
44+
45+
The meaning of these parameters is described in more detail in the [System Parameters](../../system-parameters.md) documentation.
46+
:::
47+

docs/module/develop/Gendat/Gendat.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,10 @@ Alternatively load vistle/examples/gendat-isosurface.vsl.
3636
</svg>
3737

3838
## Parameters
39+
40+
3941
|name|description|type|
4042
|-|-|-|
41-
|first_step|first timestep to read|Int|
42-
|last_step|last timestep to read (-1: last available)|Int|
43-
|step_increment|number of steps to increment|Int|
44-
|first_rank|rank for first partition of first timestep|Int|
4543
|geo_mode|geometry generation mode (Triangle_Geometry, Quad_Geometry, Polygon_Geometry, Uniform_Grid, Rectilinear_Grid, Layer_Grid, Structured_Grid, Unstructured_Grid, Point_Geometry, Sphere_Geometry)|Int|
4644
|data_mode_scalar|data generation mode (One, Dist_Origin, Identity_X, Identity_Y, Identity_Z, Sine_X, Sine_Y, Sine_Z, Cosine_X, Cosine_Y, Cosine_Z, Random)|Int|
4745
|data_scale_scalar|data scale factor (scalar)|Float|
@@ -64,3 +62,33 @@ Alternatively load vistle/examples/gendat-isosurface.vsl.
6462
|element_data|generate data per element/cell|Int|
6563
|anim_data|data animation (Constant, Add_Scale, Divide_Scale, Add_X, Add_Y, Add_Z)|Int|
6664
|delay|wait after creating an object (s)|Float|
65+
66+
67+
:::{admonition} Supported Reader Parameters
68+
:class: dropdown
69+
70+
|name|description|type|
71+
|-|-|-|
72+
|[first_step](../../reader-parameters.md#first_step)|first timestep to read|Int|
73+
|[last_step](../../reader-parameters.md#last_step)|last timestep to read (-1: last available)|Int|
74+
|[step_increment](../../reader-parameters.md#step_increment)|number of steps to increment|Int|
75+
|[first_rank](../../reader-parameters.md#first_rank)|rank for first partition of first timestep|Int|
76+
77+
The meaning of these parameters is described in more detail in the [Reader Parameters](../../reader-parameters.md) documentation.
78+
:::
79+
80+
81+
:::{admonition} Supported System Parameters
82+
:class: dropdown
83+
84+
|name|description|type|
85+
|-|-|-|
86+
|[_openmp_threads](../../system-parameters.md#_openmp_threads)|number of OpenMP threads (0: system default)|Int|
87+
|[_benchmark](../../system-parameters.md#_benchmark)|show timing information|Int|
88+
|[_concurrency](../../system-parameters.md#_concurrency)|number of tasks to keep in flight per MPI rank (-1: #cores/2)|Int|
89+
|[_prioritize_visible](../../system-parameters.md#_prioritize_visible)|prioritize currently visible timestep|Int|
90+
|[_validate_objects](../../system-parameters.md#_validate_objects)|validate data objects before sending to port (Disable, Quick, Thorough)|Int|
91+
92+
The meaning of these parameters is described in more detail in the [System Parameters](../../system-parameters.md) documentation.
93+
:::
94+

docs/module/develop/GridElementStatistics/GridElementStatistics.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,30 @@ Outputs data on the grid where only the selected element is higlighted.
3030

3131

3232
## Parameters
33+
34+
3335
|name|description|type|
3436
|-|-|-|
3537
|element_index|index of the element to inspect|Int|
3638

3739

40+
:::{admonition} Supported System Parameters
41+
:class: dropdown
42+
43+
|name|description|type|
44+
|-|-|-|
45+
|[_openmp_threads](../../system-parameters.md#_openmp_threads)|number of OpenMP threads (0: system default)|Int|
46+
|[_benchmark](../../system-parameters.md#_benchmark)|show timing information|Int|
47+
|[_concurrency](../../system-parameters.md#_concurrency)|number of tasks to keep in flight per MPI rank (-1: #cores/2)|Int|
48+
|[_cache_mode](../../system-parameters.md#_cache_mode)|input object caching (CacheNone, CacheDeleteEarly, CacheDeleteLate, CacheByName)|Int|
49+
|[_prioritize_visible](../../system-parameters.md#_prioritize_visible)|prioritize currently visible timestep|Int|
50+
|[_validate_objects](../../system-parameters.md#_validate_objects)|validate data objects before sending to port (Disable, Quick, Thorough)|Int|
51+
52+
The meaning of these parameters is described in more detail in the [System Parameters](../../system-parameters.md) documentation.
53+
:::
54+
55+
56+
3857
## Usage Examples
3958

4059
<figure float="left">

docs/module/develop/ManipulateGhosts/ManipulateGhosts.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,25 @@ modify ghost cell information
1919
</svg>
2020

2121
## Parameters
22+
23+
2224
|name|description|type|
2325
|-|-|-|
2426
|operation|operation to perform (Identity, Invert, Set, Unset, Remove)|Int|
27+
28+
29+
:::{admonition} Supported System Parameters
30+
:class: dropdown
31+
32+
|name|description|type|
33+
|-|-|-|
34+
|[_openmp_threads](../../system-parameters.md#_openmp_threads)|number of OpenMP threads (0: system default)|Int|
35+
|[_benchmark](../../system-parameters.md#_benchmark)|show timing information|Int|
36+
|[_concurrency](../../system-parameters.md#_concurrency)|number of tasks to keep in flight per MPI rank (-1: #cores/2)|Int|
37+
|[_cache_mode](../../system-parameters.md#_cache_mode)|input object caching (CacheNone, CacheDeleteEarly, CacheDeleteLate, CacheByName)|Int|
38+
|[_prioritize_visible](../../system-parameters.md#_prioritize_visible)|prioritize currently visible timestep|Int|
39+
|[_validate_objects](../../system-parameters.md#_validate_objects)|validate data objects before sending to port (Disable, Quick, Thorough)|Int|
40+
41+
The meaning of these parameters is described in more detail in the [System Parameters](../../system-parameters.md) documentation.
42+
:::
43+

0 commit comments

Comments
 (0)