serialization:hdf5dpf generate result file
Version: 0.0.0
Description
Generate a dpf result file from provided information.
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin -7 | h5_chunk_size | int32 | Size of each HDF5 chunk in kilobytes (KB). Default: 1 MB when compression is enabled; for uncompressed datasets, the default is the full dataset size x dimension. |
| Pin -6 | append_mode | bool | Experimental: Allow appending chunked data to the file. This disables fields container content deduplication. |
| Pin -5 | dataset_size_compression_threshold | int32 | Integer value that defines the minimum dataset size (in bytes) to use h5 native compression Applicable for arrays of floats, doubles and integers. |
| Pin -2 | h5_native_compression | int32, abstract_data_tree | Integer value / DataTree that defines the h5 native compression used For Integer Input {0: No Compression (default); 1-9: GZIP Compression : 9 provides maximum compression but at the slowest speed.} For DataTree Input {type: None / GZIP / ZSTD; level: GZIP (1-9) / ZSTD (1-20); num_threads: ZSTD (>0)} |
| Pin -1 | export_floats | bool | converts double to float to reduce file size (default is true) |
| Pin 0 Required | filename | string | name of the output file that will be generated (utf8). |
| Pin 1 | mesh_provider_out | abstract_meshed_region | defines the MeshedRegion that is exported and provided by MeshProvider. |
| Pin 2 | time_freq_support_out | time_freq_support | defines the TimeFreqSupport that is exported and provided by TimeFreqSupportProvider. |
| Pin 3 | ansys_unit_system_id | int32, result_info | defines the unit system the results are exported with. A Result info can be input to also export Physics Type and Analysis Type. |
| Pin 4 | input_name | string, any | Set of even and odd pins to serialize results. Odd pins (4, 6, 8...) are strings, and they represent the names of the results to be serialized. Even pins (5, 7, 9...) are DPF types, and they represent the results to be serialized. They should go in pairs (for each result name, there should be a result) and connected sequentially. |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | data_sources | data_sources | data_sources filled with the H5 generated file path. |
Configurations
| Name | Expected type(s) | Default value | Description |
|---|---|---|---|
| evaluate_inputs_before_run | bool | false | If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. |
| mutex | bool | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
Scripting
Category: serialization
Plugin: core
Scripting name: hdf5dpf_generate_result_file
Full name: serialization.hdf5dpf_generate_result_file
Internal name: hdf5::h5dpf::make_result_file
License: None
Changelog
- Version 0.0.0: Initial release.