aboutsummaryrefslogtreecommitdiff
path: root/Carpet/CarpetIOHDF5/doc/documentation.tex
diff options
context:
space:
mode:
authorThomas Radke <tradke@aei.mpg.de>2006-11-17 11:51:00 +0000
committerThomas Radke <tradke@aei.mpg.de>2006-11-17 11:51:00 +0000
commit20401366e370e7d440609b72e1af6f6243c8ae44 (patch)
tree963a7b3dc4bad9d97dc91916c490c0f9d99fa3f5 /Carpet/CarpetIOHDF5/doc/documentation.tex
parenta530bfa05b55321f5fbfbf64ce30802e7bf649d9 (diff)
CarpetIOHDF5: support automatic gzip dataset compression
With the new steerable integer parameter IOHDF5::compression_level users can now request gzip dataset compression while writing HDF5 files: levels from 1-9 specify a specific compression rate, 0 (which is the default) disables dataset compression. darcs-hash:20061117115153-776a0-7aaead5d2a0216841a27e091fddb9b6c4f40eed4.gz
Diffstat (limited to 'Carpet/CarpetIOHDF5/doc/documentation.tex')
-rw-r--r--Carpet/CarpetIOHDF5/doc/documentation.tex8
1 files changed, 8 insertions, 0 deletions
diff --git a/Carpet/CarpetIOHDF5/doc/documentation.tex b/Carpet/CarpetIOHDF5/doc/documentation.tex
index 022e0f945..c0ca6b0d9 100644
--- a/Carpet/CarpetIOHDF5/doc/documentation.tex
+++ b/Carpet/CarpetIOHDF5/doc/documentation.tex
@@ -118,6 +118,14 @@ Parameters to control the \ThisThorn\ I/O method are:
If this parameter is set to an empty string \ThisThorn\ output will go
to the standard output directory as specified in {\tt IO::out\_dir}.
+ \item {\tt IOHDF5::compression\_level (steerable)}\\
+ Compression level to use for writing HDF5 datasets.
+ Automatic {\tt gzip} dataset compression can be enabled by setting
+ this integer parameter to values between 1 and 9 (inclusive),
+ with increasing values requesting higher compression rates (at the cost
+ of additional runtime for outputting HDF5 data); a value of zero
+ (which is the default setting for this parameter) disables compression.
+
\item {\tt IO::out\_single\_precision (steerable)}\\
whether to output double-precision data in single precision