## On this page
# compression:apply zfp
Last update: 31.07.2026
**Version: 0.0.0**
## Description
Compressing input data using one of zfp compression algorithm modes.
## Inputs
This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.
Pin numberNameStatusExpected type(s)0[dataIn](#input_0)Required[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)**1**[mode](#input_1)Required[`string`](../../core-concepts/dpf-types.md#standard-types), [`char`](../../core-concepts/dpf-types.md#standard-types)**2**[mode\_parameter](#input_2)Required[`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types)**3**[dim](#input_3)[`int32`](../../core-concepts/dpf-types.md#standard-types)**4**[order](#input_4)[`int32`](../../core-concepts/dpf-types.md#standard-types)**5**[double\_absthreshold](#input_5)[`double`](../../core-concepts/dpf-types.md#standard-types)**6**[double\_relthreshold](#input_6)[`double`](../../core-concepts/dpf-types.md#standard-types)
### dataIn (Pin 0)
- **Required:** Yes
- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)
field or fields container to be compressed
### mode (Pin 1)
- **Required:** Yes
- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types), [`char`](../../core-concepts/dpf-types.md#standard-types)
zfp mode: fixed-rate ('r'), fixed-precision ('p'), fixed-accuracy ('a')
### mode\_parameter (Pin 2)
- **Required:** Yes
- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types)
mode-corresponding parameter: rate (double) / precision (int) / accuracy (double)
### dim (Pin 3)
- **Required:** No
- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)
dimension (1D/2D/3D) for data organization before the compression (int; default: 2)
### order (Pin 4)
- **Required:** No
- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)
xyz dimensions order, where x (row) corresponds to number of elementary data, y (col) - number of time steps, z - number of components (applicable only for 3d data) : 0=xyz, 1=yxz (int; default: 0)
### double\_absthreshold (Pin 5)
- **Required:** No
- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types)
Double positive small value. All the values smaller than max(small value, max(vi) \* relative threshold) are considered as zero values, (default value: 1.0e-18).
### double\_relthreshold (Pin 6)
- **Required:** No
- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types)
Double relative threshold. Values smaller than (v1 - v2) < max(small value, v1 \* relativeTol) are considered identical (default value: 1.0e-10).
## Outputs
This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.
Pin numberNameExpected type(s)0[compress\_speed](#output_0)[`double`](../../core-concepts/dpf-types.md#standard-types)**1**[compress\_ratio](#output_1)[`double`](../../core-concepts/dpf-types.md#standard-types)**2**[dataOut](#output_2)[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container)
### compress\_speed (Pin 0)
- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types)
the output entity is a double, containing compression speed of the input data: for ElementalNodal location - \[elements/sec\], for Nodal location - \[nodes/sec\]
### compress\_ratio (Pin 1)
- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types)
the output entity is a double, containing compression rate = initial/compressed
### dataOut (Pin 2)
- **Expected type(s):** [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container)
the output entity is a 'custom type field container'; each output field containing compressed results corresponding to one component data (ie. input vector field/fc contains 3 components will give 3 output fields), this is not the case when input pin3 is set to 3, all components will be compressed into one field.
## Configurations
This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior.
### [mutex](../../core-concepts/operator-configurations.md#mutex)
- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)
- **Default value:** false
If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.
### [num\_threads](../../core-concepts/operator-configurations.md#num_threads)
- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)
- **Default value:** 0
Number of threads to use to run in parallel
### [run\_in\_parallel](../../core-concepts/operator-configurations.md#run_in_parallel)
- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)
- **Default value:** true
Loops are allowed to run in parallel if the value of this config is set to true.
### [use\_cuda](../../core-concepts/operator-configurations.md#use_cuda)
- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)
- **Default value:** false
If this option is set to true, zfp fixed-rate parallel (de)compression will use CUDA.
## Scripting
This operator can be accessed through scripting interfaces using these identifiers.
**Category**: compression
**Plugin**: core
**Scripting name**: apply\_zfp
**Full name**: compression.apply\_zfp
**Internal name**: zfp
**License**: None
## Examples
These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.
C++```cpp
#include "dpf_api.h"
ansys::dpf::Operator op("zfp"); // operator instantiation
op.connect(0, my_dataIn);
op.connect(1, my_mode);
op.connect(2, my_mode_parameter);
op.connect(3, my_dim);
op.connect(4, my_order);
op.connect(5, my_double_absthreshold);
op.connect(6, my_double_relthreshold);
double my_compress_speed = op.getOutput(0);
double my_compress_ratio = op.getOutput(1);
ansys::dpf::CustomTypeFieldsContainer my_dataOut = op.getOutput(2);
```
CPython```python
import ansys.dpf.core as dpf
op = dpf.operators.compression.apply_zfp() # operator instantiation
op.inputs.dataIn.connect(my_dataIn)
op.inputs.mode.connect(my_mode)
op.inputs.mode_parameter.connect(my_mode_parameter)
op.inputs.dim.connect(my_dim)
op.inputs.order.connect(my_order)
op.inputs.double_absthreshold.connect(my_double_absthreshold)
op.inputs.double_relthreshold.connect(my_double_relthreshold)
my_compress_speed = op.outputs.compress_speed()
my_compress_ratio = op.outputs.compress_ratio()
my_dataOut = op.outputs.dataOut()
```
IPython```python
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.compression.apply_zfp() # operator instantiation
op.inputs.dataIn.Connect(my_dataIn)
op.inputs.mode.Connect(my_mode)
op.inputs.mode_parameter.Connect(my_mode_parameter)
op.inputs.dim.Connect(my_dim)
op.inputs.order.Connect(my_order)
op.inputs.double_absthreshold.Connect(my_double_absthreshold)
op.inputs.double_relthreshold.Connect(my_double_relthreshold)
my_compress_speed = op.outputs.compress_speed.GetData()
my_compress_ratio = op.outputs.compress_ratio.GetData()
my_dataOut = op.outputs.dataOut.GetData()
```
## Changelog
- Version 0.0.0: Initial release.