Skip to content

Commit 9345e3e

Browse files
rbaum-developeraumuell
authored andcommitted
add some documentation for ReadSubzoneTecplot
1 parent 3a69e4c commit 9345e3e

2 files changed

Lines changed: 29 additions & 1 deletion

File tree

module/read/ReadSubzoneTecplot/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ set(HEADERS ReadSubzoneTecplot.h)
77
set(SOURCES ReadSubzoneTecplot.cpp)
88

99
#add_definitions(-DPYBIND11_DETAILED_ERROR_MESSAGES)
10-
add_module(ReadSubzoneTecplot "read SZL Tecplot data" ${HEADERS} ${SOURCES})
10+
add_module(ReadSubzoneTecplot "read SZL (Sub-Zone Load-on-demand) Tecplot data" ${HEADERS} ${SOURCES})
1111

1212
target_link_libraries(ReadSubzoneTecplot PRIVATE vistle_tecio)
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[headline]:<>
2+
3+
## Purpose
4+
5+
The **ReadSubzoneTecplot** module reads Tecplot 360 Sub-Zone Load-on-demand (`*.szplt`) data from a directory. Only structured (ordered) zones are supported. All .szplt files found in the input directory are considered according to the selected time-step range and step increment.
6+
7+
## Ports
8+
[moduleHtml]:<>
9+
10+
11+
- `grid_out` — structured grid (all subzones)
12+
- `field_out_0` .. `field_out_4` — data fields chosen by the user (up to five).
13+
14+
The first output port (`grid_out`) provides the structured geometry. The remaining ports provide solution fields selected via the module parameters.
15+
16+
[parameters]:<>
17+
18+
## Behavior
19+
20+
- If `static_geometry` is enabled, the grid is loaded once from the specified reference time step (`static_ref_timestep`) and reused for all output timesteps.
21+
- If `static_geometry` is disabled, the geometry is reloaded for each requested timestep.
22+
- Data fields are attached to the corresponding `field_out_*` ports only if the selected field exists in the file/zone; missing fields are skipped.
23+
24+
## Related Modules
25+
26+
### Similar Modules
27+
28+
[ReadIagTecplot]()

0 commit comments

Comments
 (0)