IOSS  2.0
Ioss_Doxygen.h
Go to the documentation of this file.
1 // clang-format off
2 
3 /*! \mainpage IOSS API Documentation
4 
5 \section avail Availability
6 
7 The IOSS library source code is available on Github at
8 https://github.com/gsjaardema/seacas
9 
10 For bug reports, documentation errors, and enhancement suggestions, contact:
11 - Gregory D. Sjaardema
12 - WEB: https://github.com/gsjaardema/seacas/issues
13 - EMAIL: gdsjaar@sandia.gov
14 - EMAIL: gsjaardema@gmail.com
15 - PHONE: (505) 844-2701 (office)
16 - PHONE: (505) 999-8991 (cell)
17 
18 \section properties Properties
19 
20 ## General Properties
21 
22  Property | Value | Description
23  ----------|:--------:|------------
24  LOGGING | on/[off] | enable/disable logging of field input/output
25  LOWER_CASE_VARIABLE_NAMES | [on]/off | Convert all variable names on database to lowercase; replace ' ' with '_'
26  USE_GENERIC_CANONICAL_NAMES | on/[off] | use `block_{id}` as canonical name of an element block instead of the name (if any) stored on the database. The database name will be an alias.
27  MINIMIZE_OPEN_FILES | on/[off] | If on, then close file after each timestep and then reopen on next output
28 
29 ## Auto-Decomposition-Related Properties
30 
31  Property | Value | Description
32 -----------------|:------:|-----------------------------------------------------------
33 MODEL_DECOMPOSITION_METHOD | {method} | Decompose a DB with type `MODEL` using `method`
34 RESTART_DECOMPOSITION_METHOD | {method} | Decompose a DB with type `RESTART_IN` using `method`
35 DECOMPOSITION_METHOD | {method} | Decompose all input DB using `method`
36 PARALLEL_CONSISTENCY | [on]/off | On if the client will call Ioss functions consistently on all processors. If off, then the auto-decomp and auto-join cannot be used.
37 RETAIN_FREE_NODES | [on]/off | In auto-decomp, will nodes not connected to any elements be retained.
38 LOAD_BALANCE_THRESHOLD | {real} [1.4] | CGNS-Structured only -- Load imbalance permitted Load on Proc / Avg Load
39 
40 ### Valid values for Decomposition Method
41 
42 Method | Description
43 :---------:|-------------------
44 rcb | recursive coordinate bisection
45 rib | recursive inertial bisection
46 hsfc | hilbert space-filling curve
47 metis_sfc | metis space-filling-curve
48 kway | metis kway graph-based
49 kway_geom | metis kway graph-based method with geometry speedup
50 linear | elements in order first n/p to proc 0, next to proc 1.
51 cyclic | elements handed out to id % proc_count
52 random | elements assigned randomly to processors in a way that preserves balance (do not use for a real run)
53 external | Files are decomposed externally into a file-per-processor in a parallel run.
54 
55 ## Output File Composition -- Single File output from parallel run instead of file-per-processor
56 
57  Property | Value
58 -----------------|:------:
59 COMPOSE_RESTART | on/[off]
60 COMPOSE_RESULTS | on/[off]
61 PARALLEL_IO_MODE | mpiio, pnetcdf
62 
63 ## Properties Related to byte size of reals and integers
64 
65  Property | Value | Description
66 -----------------------|:------:|-----------------------------------------------------------
67  INTEGER_SIZE_DB | [4] / 8 | byte size of integers stored on the database.
68  INTEGER_SIZE_API | [4] / 8 | byte size of integers used in api functions.
69  REAL_SIZE_DB | 4 / [8] | byte size of floating point stored on the database.
70  REAL_SIZE_API | 4 / [8] | byte size of floating point used in api functions.
71 
72 ## Properties related to underlying file type (exodus only)
73 
74  Property | Value | Description
75 -----------------------|:------:|-----------------------------------------------------------
76  FILE_TYPE | [netcdf], netcdf4, netcdf-4, hdf5 | Underlying file type (bits on disk format)
77  COMPRESSION_LEVEL | [0]-9 | In the range [0..9]. A value of 0 indicates no compression, will automatically set `file_type=netcdf4`, recommend <=4
78  COMPRESSION_SHUFFLE | on/[off] |to enable/disable hdf5's shuffle compression algorithm.
79  MAXIMUM_NAME_LENGTH | [32] | Maximum length of names that will be returned/passed via api call.
80  APPEND_OUTPUT | on/[off] | Append output to end of existing output database
81  APPEND_OUTPUT_AFTER_STEP | {step}| Max step to read from an input db or a db being appended to (typically used with APPEND_OUTPUT)
82  APPEND_OUTPUT_AFTER_TIME | {time}| Max time to read from an input db or a db being appended to (typically used with APPEND_OUTPUT)
83 
84 ## Properties for the heartbeat output
85  Property | Value | Description
86 -----------------------|:------:|-----------------------------------------------------------
87  FLUSH_INTERVAL | int | Minimum time interval between flushing heartbeat data to disk. Default is 10 seconds
88  TIME_STAMP_FORMAT | [%H:%M:%S] | Format used to format time stamp. See strftime man page
89  SHOW_TIME_STAMP | on/off | Should the output lines be preceded by the timestamp
90  PRECISION | 0..16 [5] | Precision used for floating point output.
91  FIELD_WIDTH | 0.. | Width of an output field. If 0, then use natural width.
92  SHOW_LABELS | on/[off] | Should each field be preceded by its name (ke=1.3e9, ie=2.0e9)
93  SHOW_LEGEND | [on]/off | Should a legend be printed at the beginning of the output showing the field names for each column of data.
94  SHOW_TIME_FIELD | on/[off] | Should the current analysis time be output as the first field.
95 
96 
97 ## Experimental
98 
99  Property | Value | Description
100 -----------------------|:------:|-----------------------------------------------------------
101 MEMORY_READ | on/[off] | experimental
102 MEMORY_WRITE | on/[off] | experimental
103 ENABLE_FILE_GROUPS | on/[off] | experimental
104 
105 ## Debugging / Profiling
106 
107  Property | Value | Description
108  ----------|:--------:|------------
109  LOGGING | on/[off] | enable/disable logging of field input/output
110  DECOMP_SHOW_PROGRESS | on/[off] | show memory and elapsed time during autodecomp.
111  DECOMP_SHOW_HWM | on/[off] | show high-water memory during autodecomp
112  IOSS_TIME_FILE_OPEN_CLOSE | on/[off] | show elapsed time during parallel-io file open/close/create
113  CHECK_PARALLEL_CONSISTENCY | on/[off] | check Ioss::GroupingEntity parallel consistency
114 
115 \section license License
116 The IOSS library is licensed under the BSD open source license.
117 
118  Copyright (c) 1999-2017 National Technology & Engineering Solutions
119  of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with
120  NTESS, the U.S. Government retains certain rights in this software.
121 
122  Redistribution and use in source and binary forms, with or without
123  modification, are permitted provided that the following conditions are
124  met:
125 
126  * Redistributions of source code must retain the above copyright
127  notice, this list of conditions and the following disclaimer.
128 
129  * Redistributions in binary form must reproduce the above
130  copyright notice, this list of conditions and the following
131  disclaimer in the documentation and/or other materials provided
132  with the distribution.
133 
134  * Neither the name of NTESS nor the names of its
135  contributors may be used to endorse or promote products derived
136  from this software without specific prior written permission.
137 
138  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
139  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
140  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
141  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
142  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
143  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
144  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
145  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
146  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
147  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
148  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
149 
150 */
151 
152 // clang-format on