DPF doc daily update for 271 - dpf-mechanical

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/Operator.md

@@ -157,6 +157,18 @@ fields_container = my_op.outputs.fields_container.GetData()
 
 * **i** (*optional*)
 
+#### GetOutputAsUInt64Collection(i: int = 0) -> Collection
+
+**Parameters:**
+
+* **i** (*optional*)
+
+#### GetOutputAsUIntCollection(i: int = 0) -> Collection
+
+**Parameters:**
+
+* **i** (*optional*)
+
 #### GetOutputAsWorkflow(i: int = 0) -> Workflow
 
 **Parameters:**

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/Workflow.md

@@ -191,6 +191,24 @@ to compute progress while a workflow is running.
 
 * **outputPinName**
 
+#### GetOutputAsUInt64Collection(outputPinName: str) -> Collection
+
+**Parameters:**
+
+* **outputPinName**
+
+#### GetOutputAsUIntCollection(outputPinName: str) -> Collection
+
+**Parameters:**
+
+* **outputPinName**
+
+#### GetOutputAsULong(outputPinName: str) -> UInt64
+
+**Parameters:**
+
+* **outputPinName**
+
 #### GetRecordedId() -> int
 
 #### HasTag(tag: WorkFlowTags) -> bool

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/compression/index.md

@@ -14,3 +14,7 @@ uid: Ans.DataProcessing.operators.compression
 | [quantization](Ans_DataProcessing_operators_compression_quantization.md) | Scales a field to a given precision threshold, then rounds all the values to the unit. |
 | [quantization_fc](Ans_DataProcessing_operators_compression_quantization_fc.md) | Scales all the fields of a fields container to a given precision threshold, then rounds all the values to the unit. |
 | [zfp_decompress](Ans_DataProcessing_operators_compression_zfp_decompress.md) | zfp decompression using the information about compression written into the properties of the field(s)   ///available inputs: dataIn (CustomTypeFieldsContainer) |
+| [zstd_compress](Ans_DataProcessing_operators_compression_zstd_compress.md) | Compresses the data of a field with ZSTD compression algorithm.   ///available inputs: input_field (Field, CustomTypeField), zstd_level (Int32) (optional), num_threads (Int32) (optional) |
+| [zstd_compress_fc](Ans_DataProcessing_operators_compression_zstd_compress_fc.md) | Compresses a fields container with ZSTD compression algorithm.   ///available inputs: input_fc (FieldsContainer, CustomTypeFieldsContainer), zstd_level (Int32) (optional), num_threads (Int32) (optional) |
+| [zstd_decompress](Ans_DataProcessing_operators_compression_zstd_decompress.md) | Decompresses a field compressed with ZSTD compression algorithm.   ///available inputs: compressed_input (GenericDataContainer) |
+| [zstd_decompress_fc](Ans_DataProcessing_operators_compression_zstd_decompress_fc.md) | Decompresses a fields container compressed with ZSTD compression algorithm.   ///available inputs: compressed_input (AnyCollection) |

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/compression/zstd_compress.md

@@ -0,0 +1,74 @@
+---
+uid: Ans.DataProcessing.operators.compression.zstd_compress
+---
+
+# *class* zstd_compress(input_field: object = None, zstd_level: object = None, num_threads: object = None, config: OperatorConfig = None)
+
+Compresses the data of a field with ZSTD compression algorithm.
+
+available inputs: `input_field` (Field, CustomTypeField), `zstd_level` (Int32) (optional), `num_threads` (Int32) (optional)
+
+available outputs: `compressed_output` (GenericDataContainer), `output_bytes_size` (ulong)
+
+**DPF Framework Reference:** [zstd_compress operator specification](https://developer-a.synopsys.com/docs/dpf-framework-2027-r1/operator-specifications/compression/zstd_compress.md)
+
+**Parameters:**
+
+* **input_field**
+* **zstd_level**
+* **num_threads**
+* **config**
+
+**Example:**
+
+```python
+op = zstd_compress()
+
+op = zstd_compress(input_field=my_input_field,zstd_level=my_zstd_level,num_threads=my_num_threads)
+```
+
+## Inputs
+
+### input_field
+
+Field or custom type field of type "double" to compress.
+
+**Type:** *LinkableInput*
+
+### zstd_level
+
+**Type:** *LinkableInput*
+
+### num_threads
+
+Number of threads for parallelization : from 0 to 20. Default = 4.
+
+**Type:** *LinkableInput*
+
+## Outputs
+
+### compressed_output
+
+**Type:** *LinkableOutput*
+
+### output_bytes_size
+
+Total size of compressed data in bytes.
+
+**Type:** *LinkableOutput*
+
+## Methods
+
+## Properties
+
+#### *property* inputs: InputSpec
+
+*get/set*
+
+#### *property* outputs: OutputSpec
+
+*get/set*
+
+#### *property* defaultConfig: Config
+
+*get*

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/compression/zstd_compress_fc.md

@@ -0,0 +1,74 @@
+---
+uid: Ans.DataProcessing.operators.compression.zstd_compress_fc
+---
+
+# *class* zstd_compress_fc(input_fc: object = None, zstd_level: object = None, num_threads: object = None, config: OperatorConfig = None)
+
+Compresses a fields container with ZSTD compression algorithm.
+
+available inputs: `input_fc` (FieldsContainer, CustomTypeFieldsContainer), `zstd_level` (Int32) (optional), `num_threads` (Int32) (optional)
+
+available outputs: `compressed_fc` (AnyCollection), `output_bytes_size` (ulong)
+
+**DPF Framework Reference:** [zstd_compress_fc operator specification](https://developer-a.synopsys.com/docs/dpf-framework-2027-r1/operator-specifications/compression/zstd_compress_fc.md)
+
+**Parameters:**
+
+* **input_fc**
+* **zstd_level**
+* **num_threads**
+* **config**
+
+**Example:**
+
+```python
+op = zstd_compress_fc()
+
+op = zstd_compress_fc(input_fc=my_input_fc,zstd_level=my_zstd_level,num_threads=my_num_threads)
+```
+
+## Inputs
+
+### input_fc
+
+Fields container or custom type fields container of type "double" to compress.
+
+**Type:** *LinkableInput*
+
+### zstd_level
+
+**Type:** *LinkableInput*
+
+### num_threads
+
+Number of threads for parallelization : from 0 to 20. Default = 4.
+
+**Type:** *LinkableInput*
+
+## Outputs
+
+### compressed_fc
+
+**Type:** *LinkableOutput*
+
+### output_bytes_size
+
+Total size of the compressed data in bytes (sum of the sizes in the vector of output pin 1).
+
+**Type:** *LinkableOutput*
+
+## Methods
+
+## Properties
+
+#### *property* inputs: InputSpec
+
+*get/set*
+
+#### *property* outputs: OutputSpec
+
+*get/set*
+
+#### *property* defaultConfig: Config
+
+*get*

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/compression/zstd_decompress.md

@@ -0,0 +1,56 @@
+---
+uid: Ans.DataProcessing.operators.compression.zstd_decompress
+---
+
+# *class* zstd_decompress(compressed_input: object = None, config: OperatorConfig = None)
+
+Decompresses a field compressed with ZSTD compression algorithm.
+
+available inputs: `compressed_input` (GenericDataContainer)
+
+available outputs: `decompressed_field` (Field ,CustomTypeField)
+
+**DPF Framework Reference:** [zstd_decompress operator specification](https://developer-a.synopsys.com/docs/dpf-framework-2027-r1/operator-specifications/compression/zstd_decompress.md)
+
+**Parameters:**
+
+* **compressed_input**
+* **config**
+
+**Example:**
+
+```python
+op = zstd_decompress()
+
+op = zstd_decompress(compressed_input=my_compressed_input)
+```
+
+## Inputs
+
+### compressed_input
+
+**Type:** *LinkableInput*
+
+## Outputs
+
+### decompressed_field
+
+Decompressed field or custom type field.
+
+**Type:** *LinkableOutput*
+
+## Methods
+
+## Properties
+
+#### *property* inputs: InputSpec
+
+*get/set*
+
+#### *property* outputs: OutputSpec
+
+*get/set*
+
+#### *property* defaultConfig: Config
+
+*get*

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/compression/zstd_decompress_fc.md

@@ -0,0 +1,56 @@
+---
+uid: Ans.DataProcessing.operators.compression.zstd_decompress_fc
+---
+
+# *class* zstd_decompress_fc(compressed_input: object = None, config: OperatorConfig = None)
+
+Decompresses a fields container compressed with ZSTD compression algorithm.
+
+available inputs: `compressed_input` (AnyCollection)
+
+available outputs: `decompressed_fc` (FieldsContainer ,CustomTypeFieldsContainer)
+
+**DPF Framework Reference:** [zstd_decompress_fc operator specification](https://developer-a.synopsys.com/docs/dpf-framework-2027-r1/operator-specifications/compression/zstd_decompress_fc.md)
+
+**Parameters:**
+
+* **compressed_input**
+* **config**
+
+**Example:**
+
+```python
+op = zstd_decompress_fc()
+
+op = zstd_decompress_fc(compressed_input=my_compressed_input)
+```
+
+## Inputs
+
+### compressed_input
+
+**Type:** *LinkableInput*
+
+## Outputs
+
+### decompressed_fc
+
+Decompressed fields container or custom type fields container.
+
+**Type:** *LinkableOutput*
+
+## Methods
+
+## Properties
+
+#### *property* inputs: InputSpec
+
+*get/set*
+
+#### *property* outputs: OutputSpec
+
+*get/set*
+
+#### *property* defaultConfig: Config
+
+*get*

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/filter/filtering_max_over_time.md

@@ -4,11 +4,13 @@ uid: Ans.DataProcessing.operators.filter.filtering_max_over_time
 
 # *class* filtering_max_over_time(invariant_fc_operator: object = None, output_pin: object = None, list_of_results: object = None, threshold: object = None, config: OperatorConfig = None)
 
-Creates a filtering workflow that will filter results based on a threshold of a selected invariant.
+filtering_max_over_time()
+
+filtering_max_over_time(invariant_fc_operator: object, output_pin: object, list_of_results: object, threshold: object, config: OperatorConfig)
+
+filtering_max_over_time(config: OperatorConfig)
 
-available inputs: `invariant_fc_operator` (string), `output_pin` (Int32) (optional), `list_of_results` (string) (optional), `threshold` (double) (optional)
 
-available outputs: `workflow` (Workflow)
 
 **DPF Framework Reference:** [filtering_max_over_time operator specification](https://developer-a.synopsys.com/docs/dpf-framework-2027-r1/operator-specifications/filter/filtering_max_over_time.md)
 
@@ -20,14 +22,6 @@ available outputs: `workflow` (Workflow)
 * **threshold**
 * **config**
 
-**Example:**
-
-```python
-op = filtering_max_over_time()
-
-op = filtering_max_over_time(invariant_fc_operator=my_invariant_fc_operator,output_pin=my_output_pin,list_of_results=my_list_of_results,threshold=my_threshold)
-```
-
 ## Inputs
 
 ### invariant_fc_operator

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/filter/index.md

@@ -17,7 +17,7 @@ uid: Ans.DataProcessing.operators.filter
 | [field_low_pass_fc](Ans_DataProcessing_operators_filter_field_low_pass_fc.md) | The low pass filter returns all the values below (but not equal to) the threshold value in input.   ///available inputs: fields_container (FieldsContainer), threshold (double, Field), both (bool) (optional) |
 | [field_signed_high_pass](Ans_DataProcessing_operators_filter_field_signed_high_pass.md) | The high pass filter returns all the values above, or equal, in absolute value to the threshold value in input.   ///available inputs: field (Field, FieldsContainer), threshold (double, Field), both (bool) (optional) |
 | [field_signed_high_pass_fc](Ans_DataProcessing_operators_filter_field_signed_high_pass_fc.md) | The high pass filter returns all the values above, or equal, in absolute value to the threshold value in input.   ///available inputs: fields_container (FieldsContainer), threshold (double, Field), both (bool) (optional) |
-| [filtering_max_over_time](Ans_DataProcessing_operators_filter_filtering_max_over_time.md) | Creates a filtering workflow that will filter results based on a threshold of a selected invariant.   ///available inputs: invariant_fc_operator (string), output_pin (Int32) (optional), list_of_results (string) (optional), threshold (double) (optional) |
+| [filtering_max_over_time](Ans_DataProcessing_operators_filter_filtering_max_over_time.md) | filtering_max_over_time() |
 | [scoping_band_pass](Ans_DataProcessing_operators_filter_scoping_band_pass.md) | The band pass filter returns all the values above (but not equal to) the minimum threshold value and below (but not equal to) the maximum threshold value in input.   ///available inputs: field (Field, FieldsContainer), min_threshold (double, Field), max_threshold (double, Field) (optional) |
 | [scoping_high_pass](Ans_DataProcessing_operators_filter_scoping_high_pass.md) | The high pass filter returns all the values above (but not equal to) the threshold value in input.   ///available inputs: field (Field, FieldsContainer), threshold (double, Field), both (bool) (optional) |
 | [scoping_low_pass](Ans_DataProcessing_operators_filter_scoping_low_pass.md) | The low pass filter returns all the values below (but not equal to) the threshold value in input.   ///available inputs: field (Field, FieldsContainer), threshold (double, Field), both (bool) (optional) |

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/geo/ans_mat_property_field_provider.md

@@ -4,11 +4,13 @@ uid: Ans.DataProcessing.operators.geo.ans_mat_property_field_provider
 
 # *class* ans_mat_property_field_provider(materials_container: object = None, mesh_scoping: object = None, dependencies1: object = None, dependencies2: object = None, unit_system_or_result_info: object = None, material_physic_name: object = None, dpf_mat_id: object = None, material_vuuid: object = None, property_name: object = None, location: object = None, location_standard_condition: object = None, config: OperatorConfig = None)
 
-Load a named property from an ENGD file using ANS_MAT.Important: ANS_MAT uses different property names if compared with ENGD.If there is any value's property equaling 0.0, that means this material doesnt have that named property.This operator returns fields container of named property value. If pin 10 is set False, its scoping will be the mat IDs in Mechanicaland it is only available without dependencies.
+ans_mat_property_field_provider()
+
+ans_mat_property_field_provider(materials_container: object, mesh_scoping: object, dependencies1: object, dependencies2: object, unit_system_or_result_info: object, material_physic_name: object, dpf_mat_id: object, material_vuuid: object, property_name: object, location: object, location_standard_condition: object, config: OperatorConfig)
+
+ans_mat_property_field_provider(config: OperatorConfig)
 
-available inputs: `materials_container` (MaterialsContainer), `mesh_scoping` (Scoping) (optional), `dependencies1` (Field) (optional), `dependencies2` (Field) (optional), `unit_system_or_result_info` (ResultInfo), `material_physic_name` (string) (optional), `dpf_mat_id` (Int32, IList int, Scoping, System.Collections.IEnumerable) (optional), `material_vuuid` (string) (optional), `property_name` (string) (optional), `location` (string) (optional), `location_standard_condition` (bool) (optional)
 
-available outputs: `fields_container` (FieldsContainer)
 
 **DPF Framework Reference:** [ans_mat_property_field_provider operator specification](https://developer-a.synopsys.com/docs/dpf-framework-2027-r1/operator-specifications/geo/ans_mat_property_field_provider.md)
 
@@ -27,14 +29,6 @@ available outputs: `fields_container` (FieldsContainer)
 * **location_standard_condition**
 * **config**
 
-**Example:**
-
-```python
-op = ans_mat_property_field_provider()
-
-op = ans_mat_property_field_provider(materials_container=my_materials_container,mesh_scoping=my_mesh_scoping,dependencies1=my_dependencies1,dependencies2=my_dependencies2,unit_system_or_result_info=my_unit_system_or_result_info,material_physic_name=my_material_physic_name,dpf_mat_id=my_dpf_mat_id,material_vuuid=my_material_vuuid,property_name=my_property_name,location=my_location,location_standard_condition=my_location_standard_condition)
-```
-
 ## Inputs
 
 ### materials_container

docs/dpf/dpf-mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/geo/index.md

@@ -10,7 +10,7 @@ uid: Ans.DataProcessing.operators.geo
 |-------|-------------|
 | [ans_mat_from_materials_data](Ans_DataProcessing_operators_geo_ans_mat_from_materials_data.md) | Create ans_mat materials from materials data.   ///available inputs: material_data1 (GenericDataContainer), material_data2 (GenericDataContainer) |
 | [ans_mat_materials_provider](Ans_DataProcessing_operators_geo_ans_mat_materials_provider.md) | Provide materials through ans_mat   ///available inputs: abstract_field_support (AbstractFieldSupport), unit_system_or_result_info (ResultInfo, string, Int32), skip_missing_materials (bool), Engineering_data_file (DataSources) |
-| [ans_mat_property_field_provider](Ans_DataProcessing_operators_geo_ans_mat_property_field_provider.md) | Load a named property from an ENGD file using ANS_MAT.Important: ANS_MAT uses different property names if compared with ENGD.If there is any value's property equaling 0.0, that means this material doesnt have that named property.This operator returns fields container of named property value. If pin 10 is set False, its scoping will be the mat IDs in Mechanicaland it is only available without dependencies.   ///available inputs: materials_container (MaterialsContainer), mesh_scoping (Scoping) (optional), dependencies1 (Field) (optional), dependencies2 (Field) (optional), unit_system_or_result_info (ResultInfo), material_physic_name (string) (optional), dpf_mat_id (Int32, IList int, Scoping, System.Collections.IEnumerable) (optional), material_vuuid (string) (optional), property_name (string) (optional), location (string) (optional), location_standard_condition (bool) (optional) |
+| [ans_mat_property_field_provider](Ans_DataProcessing_operators_geo_ans_mat_property_field_provider.md) | ans_mat_property_field_provider() |
 | [cartesian_to_spherical](Ans_DataProcessing_operators_geo_cartesian_to_spherical.md) | Converts 3D field from cartesian coordinates to spherical coordinates.   ///available inputs: field (Field, FieldsContainer) |
 | [cartesian_to_spherical_fc](Ans_DataProcessing_operators_geo_cartesian_to_spherical_fc.md) | Converts 3D field from cartesian coordinates to spherical coordinates.   ///available inputs: fields_container (FieldsContainer) |
 | [element_nodal_contribution](Ans_DataProcessing_operators_geo_element_nodal_contribution.md) | Compute the fraction of the element measure attributed to each node of each element (fraction of the volume for 3D elements, fraction of the area for 2D elements or fraction of the length for 1D elements). It is computed by taking the integral of the shape function associated to each node within each element.   ///available inputs: mesh (MeshedRegion), scoping (Scoping) (optional), volume_fraction (bool) (optional) |