From bd453cce2050e361888157bafbfc3d5afb4d0595 Mon Sep 17 00:00:00 2001 From: 4rmuuser <4rmuuser@win.ansys.com> Date: Fri, 26 Sep 2025 04:11:12 -0400 Subject: [PATCH 1/2] DPF doc update for 261 (2025.09.26) --- .../averaging/elemental_difference.md | 12 +- .../averaging/elemental_difference_fc.md | 16 +-- .../averaging/elemental_fraction_fc.md | 18 +-- .../averaging/elemental_mean.md | 12 +- .../averaging/elemental_mean_fc.md | 18 +-- .../averaging/elemental_nodal_to_nodal.md | 18 +-- .../elemental_nodal_to_nodal_elemental.md | 8 +- .../elemental_nodal_to_nodal_elemental_fc.md | 12 +- .../averaging/elemental_nodal_to_nodal_fc.md | 26 ++-- .../averaging/elemental_to_elemental_nodal.md | 10 +- .../elemental_to_elemental_nodal_fc.md | 10 +- .../averaging/elemental_to_nodal.md | 14 +- .../averaging/elemental_to_nodal_fc.md | 18 +-- .../averaging/extend_to_mid_nodes.md | 10 +- .../averaging/extend_to_mid_nodes_fc.md | 14 +- .../averaging/force_summation.md | 28 ++-- .../averaging/force_summation_psd.md | 24 ++-- .../averaging/gauss_to_node_fc.md | 10 +- .../averaging/nodal_difference.md | 10 +- .../averaging/nodal_difference_fc.md | 14 +- .../averaging/nodal_fraction_fc.md | 16 +-- .../averaging/nodal_to_elemental.md | 10 +- .../averaging/nodal_to_elemental_fc.md | 20 +-- .../averaging/nodal_to_elemental_nodal.md | 10 +- .../averaging/nodal_to_elemental_nodal_fc.md | 10 +- .../averaging/to_elemental_fc.md | 22 +-- .../averaging/to_elemental_nodal_fc.md | 14 +- .../averaging/to_nodal.md | 12 +- .../averaging/to_nodal_fc.md | 18 +-- .../composite/add_default_data.md | 10 +- .../composite/composite_failure_operator.md | 16 +-- .../composite_field_variable_operator.md | 12 +- .../composite/composite_scoping_operator.md | 8 +- .../convert_sampling_point_to_json.md | 6 +- .../composite/core_shear_operator.md | 16 +-- .../composite/cuntze_operator.md | 18 +-- .../evaluate_failure_criterion_per_scope.md | 36 ++--- .../composite/evaluate_sampling_point.md | 29 ++-- .../face_sheet_wrinkling_operator.md | 18 +-- .../composite/failure_measure_converter.md | 8 +- .../composite/filter_ply_data_operator.md | 12 +- .../get_field_properties_operator.md | 8 +- .../composite/hashin_operator.md | 16 +-- .../composite/hill_operator.md | 16 +-- .../composite/hoffman_operator.md | 16 +-- .../inistate_field_variable_operator.md | 12 +- .../interlaminar_normal_stress_operator.md | 16 +-- .../composite/larc_operator.md | 20 +-- .../composite/layup_provider_operator.md | 23 +-- .../composite/ls_dyna_keyword_parser.md | 8 +- .../ls_dyna_material_support_provider.md | 6 +- .../composite/ls_dyna_preparing_results.md | 10 +- .../map_to_reference_surface_operator.md | 16 +-- ...over_multiple_failure_criteria_operator.md | 6 +- .../composite/max_strain_operator.md | 16 +-- .../mechanical_sampling_point_operator.md | 8 +- .../composite/minmax_per_element_operator.md | 12 +- .../multiple_failure_criteria_operator.md | 26 ++-- .../composite/nearest_neighbor_operator.md | 12 +- .../composite/puck_operator.md | 18 +-- .../composite/reference_surface_operator.md | 10 +- .../composite/result_definition.md | 6 +- .../composite/run_mapdl_operator.md | 12 +- .../composite/scope_config_reader.md | 8 +- .../composite/scope_generator.md | 16 +-- .../composite/shear_crimping_operator.md | 18 +-- ...short_fiber_failure_criterion_evaluator.md | 16 +-- ...iber_fatigue_equivalent_stress_operator.md | 12 +- .../short_fiber_lifetime_operator.md | 14 +- .../composite/string_container.md | 6 +- .../composite/tsai_hill_operator.md | 16 +-- .../composite/tsai_wu_operator.md | 16 +-- .../composite/unit_system_default.md | 8 +- .../composite/von_mises_operator.md | 18 +-- .../compression/apply_svd.md | 24 ++-- .../compression/apply_zfp.md | 28 ++-- .../compression/kmeans_clustering.md | 12 +- .../compression/quantization.md | 51 +++++++ .../compression/quantization_fc.md | 51 +++++++ .../compression/zfp_decompress.md | 8 +- .../filter/abc_weightings.md | 12 +- .../filter/field_band_pass.md | 10 +- .../filter/field_band_pass_fc.md | 10 +- .../filter/field_high_pass.md | 10 +- .../filter/field_high_pass_fc.md | 10 +- .../filter/field_low_pass.md | 10 +- .../filter/field_low_pass_fc.md | 10 +- .../filter/field_signed_high_pass.md | 10 +- .../filter/field_signed_high_pass_fc.md | 10 +- .../filter/filtering_max_over_time.md | 12 +- .../filter/scoping_band_pass.md | 10 +- .../filter/scoping_high_pass.md | 10 +- .../filter/scoping_low_pass.md | 10 +- .../filter/scoping_signed_high_pass.md | 10 +- .../filter/timefreq_band_pass.md | 12 +- .../filter/timefreq_high_pass.md | 12 +- .../filter/timefreq_low_pass.md | 12 +- .../filter/timefreq_signed_high_pass.md | 12 +- .../filter/timescoping_band_pass.md | 10 +- .../filter/timescoping_high_pass.md | 10 +- .../filter/timescoping_low_pass.md | 10 +- .../filter/timescoping_signed_high_pass.md | 10 +- .../geo/cartesian_to_spherical.md | 10 +- .../geo/cartesian_to_spherical_fc.md | 10 +- .../geo/element_nodal_contribution.md | 10 +- .../geo/elements_facets_surfaces_over_time.md | 12 +- .../geo/elements_volume.md | 12 +- .../geo/elements_volumes_over_time.md | 10 +- .../operator-specifications/geo/faces_area.md | 8 +- .../geo/gauss_to_node.md | 10 +- .../geo/integrate_over_elements.md | 14 +- .../operator-specifications/geo/normals.md | 14 +- .../geo/normals_provider_nl.md | 14 +- .../operator-specifications/geo/rotate.md | 12 +- .../operator-specifications/geo/rotate_fc.md | 12 +- .../geo/rotate_in_cylindrical_cs.md | 14 +- .../geo/rotate_in_cylindrical_cs_fc.md | 14 +- .../geo/spherical_to_cartesian.md | 10 +- .../geo/spherical_to_cartesian_fc.md | 10 +- .../geo/to_polar_coordinates.md | 12 +- .../invariant/convertnum_bcs_to_nod.md | 8 +- .../invariant/convertnum_nod_to_bcs.md | 8 +- .../invariant/convertnum_op.md | 12 +- .../invariant/eigen_values.md | 10 +- .../invariant/eigen_values_fc.md | 10 +- .../invariant/eigen_vectors.md | 6 +- .../invariant/eigen_vectors_fc.md | 10 +- .../invariant/invariants.md | 14 +- .../invariant/invariants_fc.md | 14 +- .../invariant/principal_invariants.md | 14 +- .../invariant/principal_invariants_fc.md | 14 +- .../invariant/segalman_von_mises_eqv.md | 10 +- .../invariant/segalman_von_mises_eqv_fc.md | 10 +- .../invariant/von_mises_eqv.md | 12 +- .../invariant/von_mises_eqv_fc.md | 12 +- .../logic/ascending_sort.md | 10 +- .../logic/ascending_sort_fc.md | 10 +- .../logic/component_selector.md | 10 +- .../logic/component_selector_fc.md | 8 +- .../logic/component_transformer.md | 10 +- .../logic/component_transformer_fc.md | 10 +- .../logic/descending_sort.md | 10 +- .../logic/descending_sort_fc.md | 10 +- .../logic/elementary_data_selector.md | 12 +- .../logic/elementary_data_selector_fc.md | 10 +- .../logic/enrich_materials.md | 8 +- .../logic/identical_anys.md | 16 +-- .../logic/identical_fc.md | 14 +- .../logic/identical_fields.md | 14 +- .../identical_generic_data_containers.md | 16 +-- .../logic/identical_mc.md | 16 +-- .../logic/identical_meshes.md | 14 +- .../logic/identical_pfc.md | 10 +- .../logic/identical_property_fields.md | 10 +- .../logic/identical_sc.md | 10 +- .../logic/identical_scopings.md | 10 +- .../logic/identical_string_fields.md | 10 +- .../logic/included_fields.md | 14 +- .../logic/solid_shell_fields.md | 50 +++++++ .../logic/split_data_sources.md | 10 +- .../logic/split_streams.md | 10 +- .../operator-specifications/mapping/fft.md | 16 +-- .../mapping/find_reduced_coordinates.md | 12 +- .../mapping/on_coordinates.md | 17 +-- .../mapping/on_reduced_coordinates.md | 14 +- .../mapping/prep_sampling_fft.md | 12 +- .../mapping/prepare_mapping_workflow.md | 12 +- .../mapping/scoping_on_coordinates.md | 8 +- .../mapping/solid_to_skin.md | 12 +- .../mapping/solid_to_skin_fc.md | 16 ++- .../math/absolute_value_by_component.md | 6 +- .../math/absolute_value_by_component_fc.md | 6 +- .../math/accumulate.md | 10 +- .../math/accumulate_fc.md | 10 +- .../math/accumulate_level_over_label_fc.md | 10 +- .../math/accumulate_min_over_label_fc.md | 10 +- .../math/accumulate_over_label_fc.md | 10 +- .../math/accumulation_per_scoping.md | 15 +- .../operator-specifications/math/add.md | 22 +-- .../math/add_constant.md | 8 +- .../math/add_constant_fc.md | 8 +- .../operator-specifications/math/add_fc.md | 18 +-- .../operator-specifications/math/amplitude.md | 8 +- .../math/amplitude_fc.md | 6 +- .../math/average_over_label_fc.md | 10 +- .../operator-specifications/math/centroid.md | 16 +-- .../math/centroid_fc.md | 14 +- .../math/component_wise_divide.md | 22 +-- .../math/component_wise_divide_fc.md | 20 +-- .../math/component_wise_product.md | 22 +-- .../math/component_wise_product_fc.md | 22 +-- .../math/compute_residual_and_error.md | 22 +-- .../operator-specifications/math/conjugate.md | 6 +- .../math/correlation.md | 14 +- .../operator-specifications/math/cos.md | 6 +- .../operator-specifications/math/cos_fc.md | 6 +- .../math/cplx_derive.md | 12 +- .../math/cplx_divide.md | 8 +- .../operator-specifications/math/cplx_dot.md | 20 +-- .../math/cplx_multiply.md | 20 +-- .../math/cross_product.md | 20 +-- .../math/cross_product_fc.md | 20 +-- .../operator-specifications/math/dot.md | 22 +-- .../math/dot_tensor.md | 20 +-- .../math/entity_extractor.md | 8 +- .../math/expansion_psd.md | 18 +-- .../math/exponential.md | 6 +- .../math/exponential_fc.md | 6 +- .../math/fft_approx.md | 28 ++-- .../operator-specifications/math/fft_eval.md | 10 +- .../math/fft_gradient_eval.md | 10 +- .../math/fft_multi_harmonic_minmax.md | 26 ++-- .../math/generalized_inner_product.md | 20 +-- .../math/generalized_inner_product_fc.md | 20 +-- .../math/hdf5_topo_elemental_density.md | 14 +- .../math/hdf5_topo_nodal_density.md | 14 +- .../operator-specifications/math/img_part.md | 6 +- .../operator-specifications/math/invert.md | 6 +- .../operator-specifications/math/invert_fc.md | 6 +- .../math/kronecker_prod.md | 12 +- .../math/linear_combination.md | 14 +- .../operator-specifications/math/ln.md | 6 +- .../operator-specifications/math/ln_fc.md | 6 +- .../operator-specifications/math/mac.md | 10 +- .../math/make_one_on_comp.md | 8 +- .../math/matrix_inverse.md | 6 +- .../math/mechanical_min_max_over_time.md | 10 +- .../operator-specifications/math/minus.md | 22 +-- .../operator-specifications/math/minus_fc.md | 22 +-- .../math/modal_damping_ratio.md | 14 +- .../math/modal_participation.md | 14 +- .../math/modal_superposition.md | 21 +-- .../operator-specifications/math/modulus.md | 6 +- .../operator-specifications/math/norm.md | 8 +- .../operator-specifications/math/norm_fc.md | 12 +- .../math/outer_product.md | 20 +-- .../math/overall_dot.md | 8 +- .../operator-specifications/math/phase.md | 8 +- .../operator-specifications/math/phase_fc.md | 6 +- .../math/polar_to_cplx.md | 6 +- .../operator-specifications/math/pow.md | 8 +- .../operator-specifications/math/pow_fc.md | 8 +- .../operator-specifications/math/qr_solve.md | 8 +- .../operator-specifications/math/real_part.md | 6 +- .../math/relative_error.md | 24 ++-- .../operator-specifications/math/scale.md | 14 +- .../math/scale_by_field.md | 20 +-- .../math/scale_by_field_fc.md | 20 +-- .../operator-specifications/math/scale_fc.md | 18 +-- .../operator-specifications/math/sin.md | 6 +- .../operator-specifications/math/sin_fc.md | 6 +- .../operator-specifications/math/sqr.md | 12 +- .../operator-specifications/math/sqr_fc.md | 12 +- .../operator-specifications/math/sqrt.md | 6 +- .../operator-specifications/math/sqrt_fc.md | 6 +- .../operator-specifications/math/svd.md | 10 +- .../math/sweeping_phase.md | 18 +-- .../math/sweeping_phase_fc.md | 14 +- .../math/time_derivation.md | 8 +- .../math/time_freq_interpolation.md | 18 +-- .../math/time_integration.md | 14 +- .../math/unit_convert.md | 10 +- .../math/unit_convert_fc.md | 10 +- .../math/window_bartlett.md | 6 +- .../math/window_bartlett_fc.md | 6 +- .../math/window_blackman.md | 6 +- .../math/window_blackman_fc.md | 6 +- .../math/window_hamming.md | 6 +- .../math/window_hamming_fc.md | 6 +- .../math/window_hanning.md | 6 +- .../math/window_hanning_fc.md | 6 +- .../math/window_triangular.md | 6 +- .../math/window_triangular_fc.md | 6 +- .../math/window_welch.md | 6 +- .../math/window_welch_fc.md | 6 +- .../mesh/acmo_mesh_provider.md | 8 +- .../mesh/beam_properties.md | 38 ++--- .../operator-specifications/mesh/change_cs.md | 12 +- .../mesh/combine_levelset.md | 8 +- .../mesh/decimate_mesh.md | 10 +- .../mesh/exclude_levelset.md | 8 +- .../mesh/external_layer.md | 10 +- .../mesh/from_field.md | 6 +- .../mesh/from_scoping.md | 14 +- .../mesh/from_scopings.md | 12 +- .../mesh/iso_surfaces.md | 16 +-- .../mesh/make_plane_levelset.md | 10 +- .../mesh/make_sphere_levelset.md | 10 +- .../operator-specifications/mesh/mesh_clip.md | 16 +-- .../operator-specifications/mesh/mesh_cut.md | 14 +- .../mesh/mesh_extraction.md | 10 +- .../mesh/mesh_get_attribute.md | 10 +- .../mesh/mesh_plan_clip.md | 12 +- .../mesh/mesh_provider.md | 22 +-- .../mesh/mesh_to_graphics.md | 14 +- .../mesh/mesh_to_graphics_edges.md | 12 +- .../mesh/mesh_to_pyvista.md | 20 +-- .../mesh/mesh_to_tetra.md | 10 +- .../mesh/meshes_provider.md | 20 +-- .../mesh/morphed_field.md | 20 +-- .../operator-specifications/mesh/morphing.md | 22 +-- .../mesh/node_coordinates.md | 6 +- .../mesh/points_from_coordinates.md | 8 +- .../mesh/prepare_morphing.md | 8 +- .../operator-specifications/mesh/skin.md | 20 +-- .../mesh/split_fields.md | 8 +- .../mesh/split_mesh.md | 10 +- .../mesh/stl_export.md | 8 +- .../mesh/tri_mesh_skin.md | 12 +- .../operator-specifications/mesh/wireframe.md | 8 +- .../metadata/boundary_condition_provider.md | 12 +- .../coordinate_system_data_provider.md | 14 +- .../metadata/cyclic_mesh_expansion.md | 12 +- .../metadata/cyclic_support_provider.md | 20 +-- .../metadata/datasources_provider.md | 6 +- .../metadata/element_types_provider.md | 14 +- .../metadata/integrate_over_time_freq.md | 10 +- .../metadata/is_cyclic.md | 9 +- .../metadata/material_support_provider.md | 12 +- .../metadata/mesh_info_provider.md | 16 +-- .../metadata/mesh_property_provider.md | 14 +- .../mesh_selection_manager_provider.md | 12 +- .../metadata/mesh_support_provider.md | 12 +- .../property_field_provider_by_name.md | 12 +- .../metadata/real_constants_provider.md | 14 +- .../metadata/result_info_provider.md | 14 +- .../metadata/streams_provider.md | 10 +- .../metadata/time_freq_provider.md | 12 +- .../time_freq_support_get_attribute.md | 12 +- .../min_max/max_by_component.md | 8 +- .../min_max/max_over_phase.md | 12 +- .../min_max/max_over_time_by_entity.md | 12 +- .../min_max/min_by_component.md | 8 +- .../min_max/min_max.md | 8 +- .../min_max/min_max_by_entity.md | 8 +- .../min_max/min_max_by_time.md | 12 +- .../min_max/min_max_fc.md | 8 +- .../min_max/min_max_fc_inc.md | 10 +- .../min_max/min_max_inc.md | 14 +- .../min_max/min_max_over_label_fc.md | 18 +-- .../min_max/min_max_over_time_by_entity.md | 23 +-- .../min_max/min_over_time_by_entity.md | 12 +- .../min_max/phase_of_max.md | 12 +- .../min_max/time_of_max_by_entity.md | 12 +- .../min_max/time_of_min_by_entity.md | 10 +- .../result/acceleration.md | 30 ++-- .../result/acceleration_X.md | 24 ++-- .../result/acceleration_Y.md | 24 ++-- .../result/acceleration_Z.md | 24 ++-- .../result/accu_eqv_creep_strain.md | 63 ++++++--- .../result/accu_eqv_plastic_strain.md | 63 ++++++--- .../result/add_rigid_body_motion.md | 14 +- .../result/add_rigid_body_motion_fc.md | 14 +- .../result/artificial_hourglass_energy.md | 22 +-- .../result/beam_axial_force.md | 18 +-- .../result/beam_axial_plastic_strain.md | 16 +-- .../result/beam_axial_stress.md | 20 +-- .../result/beam_axial_total_strain.md | 20 +-- .../result/beam_rs_shear_stress.md | 16 +-- .../result/beam_s_bending_moment.md | 18 +-- .../result/beam_s_shear_force.md | 18 +-- .../result/beam_t_bending_moment.md | 18 +-- .../result/beam_t_shear_force.md | 18 +-- .../result/beam_torsional_moment.md | 18 +-- .../result/beam_tr_shear_stress.md | 16 +-- .../result/cgns_result_provider.md | 16 +-- .../result/cms_dst_table_provider.md | 6 +- .../result/cms_matrices_provider.md | 8 +- .../result/cms_subfile_info_provider.md | 12 +- .../result/co_energy.md | 22 +-- .../result/compute_invariant_terms_motion.md | 48 +++---- .../result/compute_invariant_terms_rbd.md | 68 ++++----- .../result/compute_stress.md | 16 +-- .../result/compute_stress_1.md | 16 +-- .../result/compute_stress_2.md | 16 +-- .../result/compute_stress_3.md | 16 +-- .../result/compute_stress_X.md | 16 +-- .../result/compute_stress_XY.md | 16 +-- .../result/compute_stress_XZ.md | 16 +-- .../result/compute_stress_Y.md | 16 +-- .../result/compute_stress_YZ.md | 16 +-- .../result/compute_stress_Z.md | 16 +-- .../result/compute_stress_von_mises.md | 16 +-- .../result/compute_total_strain.md | 24 ++-- .../result/compute_total_strain_1.md | 24 ++-- .../result/compute_total_strain_2.md | 24 ++-- .../result/compute_total_strain_3.md | 24 ++-- .../result/compute_total_strain_X.md | 24 ++-- .../result/compute_total_strain_XY.md | 24 ++-- .../result/compute_total_strain_XZ.md | 24 ++-- .../result/compute_total_strain_Y.md | 24 ++-- .../result/compute_total_strain_YZ.md | 24 ++-- .../result/compute_total_strain_Z.md | 24 ++-- .../contact_fluid_penetration_pressure.md | 71 +++++++--- .../result/contact_friction_stress.md | 71 +++++++--- .../result/contact_gap_distance.md | 71 +++++++--- .../result/contact_penetration.md | 71 +++++++--- .../result/contact_pressure.md | 71 +++++++--- .../result/contact_sliding_distance.md | 71 +++++++--- .../result/contact_status.md | 71 +++++++--- .../result/contact_surface_heat_flux.md | 71 +++++++--- .../result/contact_total_stress.md | 71 +++++++--- .../result/coordinate_system.md | 10 +- .../result/coordinates.md | 22 +-- .../result/creep_strain.md | 93 +++++++++++++ .../result/creep_strain_X.md | 61 ++++++++ .../result/creep_strain_XY.md | 61 ++++++++ .../result/creep_strain_XZ.md | 61 ++++++++ .../result/creep_strain_Y.md | 61 ++++++++ .../result/creep_strain_YZ.md | 61 ++++++++ .../result/creep_strain_Z.md | 61 ++++++++ .../result/creep_strain_energy_density.md | 63 ++++++--- .../result/creep_strain_eqv.md | 93 +++++++++++++ .../result/creep_strain_intensity.md | 62 +++++++++ .../result/creep_strain_max_shear.md | 62 +++++++++ .../result/creep_strain_principal_1.md | 62 +++++++++ .../result/creep_strain_principal_2.md | 62 +++++++++ .../result/creep_strain_principal_3.md | 62 +++++++++ .../result/current_density.md | 30 ++-- .../result/cyclic_analytic_seqv_max.md | 20 +-- .../result/cyclic_analytic_usum_max.md | 20 +-- .../result/cyclic_expansion.md | 32 ++--- .../operator-specifications/result/density.md | 18 +-- .../result/displacement.md | 30 ++-- .../result/displacement_X.md | 24 ++-- .../result/displacement_Y.md | 24 ++-- .../result/displacement_Z.md | 24 ++-- .../result/div_lighthill_tensor.md | 18 +-- .../result/dynamic_viscosity.md | 18 +-- .../result/elastic_strain.md | 71 +++++++--- .../result/elastic_strain_X.md | 28 ++-- .../result/elastic_strain_XY.md | 28 ++-- .../result/elastic_strain_XZ.md | 28 ++-- .../result/elastic_strain_Y.md | 28 ++-- .../result/elastic_strain_YZ.md | 28 ++-- .../result/elastic_strain_Z.md | 28 ++-- .../result/elastic_strain_energy_density.md | 63 ++++++--- .../result/elastic_strain_eqv.md | 63 ++++++--- .../result/elastic_strain_intensity.md | 29 ++-- .../result/elastic_strain_max_shear.md | 29 ++-- .../result/elastic_strain_principal_1.md | 31 +++-- .../result/elastic_strain_principal_2.md | 31 +++-- .../result/elastic_strain_principal_3.md | 31 +++-- .../elastic_strain_rotation_by_euler_nodes.md | 10 +- .../result/electric_field.md | 63 ++++++--- .../result/electric_field_X.md | 28 ++-- .../result/electric_field_Y.md | 28 ++-- .../result/electric_field_Z.md | 28 ++-- .../result/electric_flux_density.md | 63 ++++++--- .../result/electric_flux_density_X.md | 28 ++-- .../result/electric_flux_density_Y.md | 28 ++-- .../result/electric_flux_density_Z.md | 28 ++-- .../result/electric_potential.md | 22 +-- .../result/element_centroids.md | 22 +-- .../result/element_nodal_forces.md | 73 +++++++--- .../result/element_orientations.md | 63 ++++++--- .../result/element_orientations_X.md | 28 ++-- .../result/element_orientations_Y.md | 28 ++-- .../result/element_orientations_Z.md | 28 ++-- .../result/elemental_heat_generation.md | 22 +-- .../result/elemental_mass.md | 22 +-- .../result/elemental_volume.md | 30 ++-- .../result/enf_rotation_by_euler_nodes.md | 10 +- .../result/enthalpy.md | 18 +-- .../operator-specifications/result/entropy.md | 18 +-- .../operator-specifications/result/epsilon.md | 18 +-- .../result/equivalent_mass.md | 30 ++-- .../result/equivalent_radiated_power.md | 20 +-- .../result/eqv_stress_parameter.md | 63 ++++++--- .../result/erp_radiation_efficiency.md | 14 +- .../result/euler_load_buckling.md | 16 +-- .../result/euler_nodes.md | 14 +- .../result/fluid_velocity.md | 58 ++++++++ .../result/gasket_inelastic_closure.md | 62 ++++++--- .../result/gasket_inelastic_closure_X.md | 27 ++-- .../result/gasket_inelastic_closure_XY.md | 27 ++-- .../result/gasket_inelastic_closure_XZ.md | 27 ++-- .../result/gasket_stress.md | 62 ++++++--- .../result/gasket_stress_X.md | 27 ++-- .../result/gasket_stress_XY.md | 27 ++-- .../result/gasket_stress_XZ.md | 27 ++-- .../result/gasket_thermal_closure.md | 62 ++++++--- .../result/gasket_thermal_closure_X.md | 27 ++-- .../result/gasket_thermal_closure_XY.md | 27 ++-- .../result/gasket_thermal_closure_XZ.md | 27 ++-- .../result/gasket_total_closure.md | 58 ++++++++ .../result/gasket_total_closure_X.md | 60 ++++++++ .../result/gasket_total_closure_XY.md | 60 ++++++++ .../result/gasket_total_closure_XZ.md | 60 ++++++++ .../result/global_added_mass.md | 10 +- .../result/global_added_mass_pct.md | 10 +- .../result/global_center_mass.md | 10 +- .../result/global_energy_ratio.md | 10 +- .../result/global_energy_ratio_wo_eroded.md | 10 +- .../result/global_eroded_hourglass_energy.md | 10 +- .../result/global_eroded_internal_energy.md | 10 +- .../result/global_eroded_kinetic_energy.md | 10 +- .../result/global_external_work.md | 10 +- .../result/global_hourglass_energy.md | 10 +- .../result/global_internal_energy.md | 10 +- .../result/global_joint_internal_energy.md | 10 +- .../result/global_kinetic_energy.md | 10 +- .../global_rigid_body_stopper_energy.md | 10 +- .../result/global_sliding_interface_energy.md | 10 +- .../result/global_spring_damper_energy.md | 10 +- .../result/global_system_damping_energy.md | 10 +- .../result/global_time_step.md | 10 +- .../result/global_total_energy.md | 10 +- .../result/global_total_mass.md | 10 +- .../result/global_velocity.md | 10 +- .../result/heat_flux.md | 71 +++++++--- .../result/heat_flux_X.md | 28 ++-- .../result/heat_flux_Y.md | 28 ++-- .../result/heat_flux_Z.md | 28 ++-- .../result/hydrostatic_pressure.md | 63 ++++++--- .../result/incremental_energy.md | 22 +-- .../result/initial_coordinates.md | 22 +-- .../result/interface_contact_area.md | 12 +- .../result/interface_contact_force.md | 12 +- .../result/interface_contact_mass.md | 12 +- .../result/interface_contact_moment.md | 12 +- .../interface_resultant_contact_force.md | 12 +- .../result/joint_force_reaction.md | 22 +-- .../result/joint_moment_reaction.md | 22 +-- .../result/joint_relative_acceleration.md | 22 +-- .../joint_relative_angular_acceleration.md | 22 +-- .../result/joint_relative_angular_velocity.md | 22 +-- .../result/joint_relative_displacement.md | 22 +-- .../result/joint_relative_rotation.md | 22 +-- .../result/joint_relative_velocity.md | 22 +-- .../result/kinetic_energy.md | 30 ++-- .../result/mach_number.md | 18 +-- .../result/magnetic_field.md | 63 ++++++--- .../result/magnetic_field_X.md | 28 ++-- .../result/magnetic_field_Y.md | 28 ++-- .../result/magnetic_field_Z.md | 28 ++-- .../result/magnetic_flux_density.md | 63 ++++++--- .../result/magnetic_flux_density_X.md | 28 ++-- .../result/magnetic_flux_density_Y.md | 28 ++-- .../result/magnetic_flux_density_Z.md | 28 ++-- .../result/magnetic_scalar_potential.md | 22 +-- .../result/magnetic_vector_potential.md | 22 +-- .../result/mapdl.global_to_nodal.md | 8 +- .../result/mapdl.pres_to_field.md | 8 +- .../result/mapdl.prns_to_field.md | 8 +- .../result/mapdl.run.md | 19 +-- .../result/mapdl_material_properties.md | 12 +- .../result/mapdl_section.md | 18 +-- .../result/mapdl_split_on_facet_indices.md | 16 +-- .../mapdl_split_to_acmo_facet_indices.md | 8 +- .../result/mass_flow_rate.md | 18 +-- .../result/mass_fraction.md | 18 +-- .../result/material_property_of_element.md | 8 +- .../result/mean_static_pressure.md | 18 +-- .../result/mean_temperature.md | 18 +-- .../result/mean_velocity.md | 18 +-- .../members_in_bending_not_certified.md | 24 ++-- .../members_in_compression_not_certified.md | 26 ++-- ...inear_compression_bending_not_certified.md | 30 ++-- .../result/migrate_to_h5dpf.md | 24 ++-- .../result/modal_acceleration.md | 58 ++++++++ .../result/modal_basis.md | 22 +-- .../result/modal_coordinate.md | 58 ++++++++ .../result/modal_velocity.md | 58 ++++++++ .../operator-specifications/result/nmisc.md | 34 ++--- .../result/nodal_force.md | 22 +-- .../result/nodal_moment.md | 22 +-- .../result/nodal_rotation.md | 58 ++++++++ .../result/nodal_rotation_X.md | 59 ++++++++ .../result/nodal_rotation_Y.md | 59 ++++++++ .../result/nodal_rotation_Z.md | 59 ++++++++ .../result/nodal_rotational_acceleration.md | 58 ++++++++ .../result/nodal_rotational_acceleration_X.md | 59 ++++++++ .../result/nodal_rotational_acceleration_Y.md | 59 ++++++++ .../result/nodal_rotational_acceleration_Z.md | 59 ++++++++ .../result/nodal_rotational_velocity.md | 58 ++++++++ .../result/nodal_rotational_velocity_X.md | 59 ++++++++ .../result/nodal_rotational_velocity_Y.md | 59 ++++++++ .../result/nodal_rotational_velocity_Z.md | 59 ++++++++ .../result/nodal_to_global.md | 8 +- .../result/normal_contact_force.md | 22 +-- .../result/normal_contact_moment.md | 22 +-- .../result/num_surface_status_changes.md | 71 +++++++--- .../operator-specifications/result/omega.md | 18 +-- .../result/part_added_mass.md | 12 +- .../result/part_eroded_internal_energy.md | 12 +- .../result/part_eroded_kinetic_energy.md | 12 +- .../result/part_hourglass_energy.md | 12 +- .../result/part_internal_energy.md | 12 +- .../result/part_kinetic_energy.md | 12 +- .../result/part_momentum.md | 12 +- .../result/part_rigid_body_velocity.md | 12 +- .../result/plastic_state_variable.md | 63 ++++++--- .../result/plastic_strain.md | 63 ++++++--- .../result/plastic_strain_X.md | 28 ++-- .../result/plastic_strain_XY.md | 28 ++-- .../result/plastic_strain_XZ.md | 28 ++-- .../result/plastic_strain_Y.md | 28 ++-- .../result/plastic_strain_YZ.md | 28 ++-- .../result/plastic_strain_Z.md | 28 ++-- .../result/plastic_strain_energy_density.md | 63 ++++++--- .../result/plastic_strain_eqv.md | 63 ++++++--- .../result/plastic_strain_intensity.md | 29 ++-- .../result/plastic_strain_max_shear.md | 29 ++-- .../result/plastic_strain_principal_1.md | 31 +++-- .../result/plastic_strain_principal_2.md | 31 +++-- .../result/plastic_strain_principal_3.md | 31 +++-- .../plastic_strain_rotation_by_euler_nodes.md | 10 +- .../result/poynting_vector.md | 16 +-- .../result/poynting_vector_surface.md | 16 +-- .../result/pressure.md | 22 +-- .../result/pretension.md | 26 ++-- .../result/raw_displacement.md | 22 +-- .../result/raw_reaction_force.md | 22 +-- .../result/reaction_force.md | 22 +-- .../result/reaction_force_X.md | 24 ++-- .../result/reaction_force_Y.md | 24 ++-- .../result/reaction_force_Z.md | 24 ++-- .../result/read_cms_rbd_file.md | 50 +++---- .../recombine_harmonic_indeces_cyclic.md | 15 +- .../result/remove_rigid_body_motion.md | 16 +-- .../result/remove_rigid_body_motion_fc.md | 16 +-- .../result/result_provider.md | 22 +-- .../result/rigid_transformation.md | 8 +- .../result/rigid_transformation_provider.md | 8 +- .../result/rms_static_pressure.md | 18 +-- .../result/rms_temperature.md | 18 +-- .../result/rms_velocity.md | 18 +-- .../result/rom_data_provider.md | 38 ++--- .../operator-specifications/result/smisc.md | 34 ++--- .../result/specific_heat.md | 18 +-- .../result/spectrum_data.md | 22 +-- .../result/state_variable.md | 65 ++++++--- .../result/static_pressure.md | 18 +-- .../result/stiffness_matrix_energy.md | 30 ++-- .../result/strain_eqv_as_mechanical.md | 24 ++-- .../strain_eqv_as_mechanical_workflow.md | 20 +-- .../operator-specifications/result/stress.md | 71 +++++++--- .../result/stress_X.md | 28 ++-- .../result/stress_XY.md | 28 ++-- .../result/stress_XZ.md | 28 ++-- .../result/stress_Y.md | 28 ++-- .../result/stress_YZ.md | 28 ++-- .../result/stress_Z.md | 28 ++-- .../result/stress_eqv_as_mechanical.md | 22 +-- .../stress_eqv_as_mechanical_workflow.md | 20 +-- .../result/stress_intensity.md | 29 ++-- .../result/stress_max_shear.md | 29 ++-- .../result/stress_principal_1.md | 29 ++-- .../result/stress_principal_2.md | 29 ++-- .../result/stress_principal_3.md | 29 ++-- .../result/stress_ratio.md | 63 ++++++--- .../result/stress_rotation_by_euler_nodes.md | 10 +- .../result/stress_von_mises.md | 29 ++-- .../result/structural_temperature.md | 63 ++++++--- .../result/superficial_velocity.md | 18 +-- .../result/surface_heat_rate.md | 18 +-- .../result/swelling_strains.md | 63 ++++++--- .../result/tangential_contact_force.md | 22 +-- .../result/tangential_contact_moment.md | 22 +-- .../result/temperature.md | 34 ++--- .../result/temperature_grad.md | 63 ++++++--- .../result/temperature_grad_X.md | 28 ++-- .../result/temperature_grad_Y.md | 28 ++-- .../result/temperature_grad_Z.md | 28 ++-- .../result/thermal_conductivity.md | 18 +-- .../result/thermal_dissipation_energy.md | 22 +-- .../result/thermal_strain.md | 63 ++++++--- .../result/thermal_strain_X.md | 28 ++-- .../result/thermal_strain_XY.md | 28 ++-- .../result/thermal_strain_XZ.md | 28 ++-- .../result/thermal_strain_Y.md | 28 ++-- .../result/thermal_strain_YZ.md | 28 ++-- .../result/thermal_strain_Z.md | 28 ++-- .../result/thermal_strain_principal_1.md | 31 +++-- .../result/thermal_strain_principal_2.md | 31 +++-- .../result/thermal_strain_principal_3.md | 31 +++-- .../result/thermal_strains_eqv.md | 63 ++++++--- .../result/thickness.md | 22 +-- .../operator-specifications/result/torque.md | 8 +- .../result/total_contact_force.md | 22 +-- .../result/total_contact_moment.md | 22 +-- .../result/total_mass.md | 6 +- .../result/total_pressure.md | 18 +-- .../result/total_strain.md | 22 +-- .../result/total_temperature.md | 18 +-- .../result/transform_invariant_terms_rbd.md | 100 ++++++------- .../result/transient_rayleigh_integration.md | 18 +-- .../result/turbulent_kinetic_energy.md | 18 +-- .../result/turbulent_viscosity.md | 18 +-- .../result/velocity.md | 34 ++--- .../result/velocity_X.md | 24 ++-- .../result/velocity_Y.md | 24 ++-- .../result/velocity_Z.md | 24 ++-- .../result/volume_fraction.md | 18 +-- .../result/wall_shear_stress.md | 18 +-- .../result/workflow_energy_per_component.md | 29 ++-- .../result/workflow_energy_per_harmonic.md | 15 +- .../result/write_cms_rbd_file.md | 52 +++---- .../result/write_motion_dfmf_file.md | 42 +++--- .../operator-specifications/result/y_plus.md | 18 +-- .../scoping/adapt_with_scopings_container.md | 13 +- .../scoping/change_fc.md | 12 +- .../scoping/compute_element_centroids.md | 12 +- .../scoping/connectivity_ids.md | 12 +- .../scoping/elemental_from_mesh.md | 6 +- .../scoping/from_mesh.md | 8 +- .../scoping/intersect.md | 10 +- .../scoping/nodal_from_mesh.md | 6 +- .../scoping/on_mesh_property.md | 14 +- .../scoping/on_named_selection.md | 14 +- .../scoping/on_property.md | 16 +-- .../scoping/reduce_sampling.md | 8 +- .../scoping/rescope.md | 14 +- .../scoping/rescope_custom_type_field.md | 14 +- .../scoping/rescope_fc.md | 14 +- .../scoping/rescope_property_field.md | 14 +- .../scoping/scoping_get_attribute.md | 8 +- .../scoping/split_on_property_type.md | 14 +- .../scoping/transpose.md | 12 +- .../serialization/csv_to_field.md | 8 +- .../serialization/data_tree_to_json.md | 8 +- .../serialization/data_tree_to_txt.md | 8 +- .../serialization/deserializer.md | 8 +- .../serialization/export_mesh_with_prime.md | 6 +- .../serialization/export_symbolic_workflow.md | 12 +- .../serialization/field_to_csv.md | 8 +- .../serialization/hdf5dpf_custom_read.md | 14 +- .../hdf5dpf_generate_result_file.md | 24 ++-- .../serialization/import_symbolic_workflow.md | 8 +- .../serialization/json_to_data_tree.md | 6 +- .../serialization/mechanical_csv_to_field.md | 12 +- .../serialization/migrate_file_to_vtk.md | 10 +- .../serialization/migrate_to_vtu.md | 20 +-- .../serialization/serialize_to_hdf5.md | 8 +- .../serialization/serializer.md | 10 +- .../serialization/serializer_to_string.md | 9 +- .../serialization/string_deserializer.md | 8 +- .../serialization/txt_to_data_tree.md | 6 +- .../serialization/vtk_export.md | 10 +- .../serialization/vtk_to_fields.md | 10 +- .../serialization/vtu_export.md | 22 +-- .../serialization/workflow_to_pydpf.md | 8 +- .../workflow_to_workflow_topology.md | 6 +- .../server/grpc_shutdown_server.md | 4 +- .../server/grpc_start_server.md | 16 +-- .../sound/append_zeros_to_signal.md | 8 +- .../sound/apply_gain.md | 10 +- .../sound/compute_PR.md | 20 ++- .../sound/compute_TNR.md | 20 ++- .../sound/compute_fluctuation_strength.md | 8 +- .../sound/compute_istft.md | 8 +- .../sound/compute_level_over_time.md | 22 +-- .../sound/compute_loudness_ansi_s3_4.md | 10 +- .../sound/compute_loudness_iso532_1.md | 12 +- ...mpute_loudness_iso532_1_frequency_input.md | 12 +- .../compute_loudness_iso532_1_vs_time.md | 18 +-- .../sound/compute_loudness_iso532_2.md | 20 +-- .../sound/compute_octave_levels_from_psd.md | 50 +++++++ ..._octave_levels_from_psd_ansi_s1_11_1986.md | 50 +++++++ .../compute_octave_levels_from_signal.md | 50 +++++++ ...ompute_one_third_octave_levels_from_psd.md | 50 +++++++ ..._octave_levels_from_psd_ansi_s1_11_1986.md | 50 +++++++ ...ute_one_third_octave_levels_from_signal.md | 50 +++++++ .../sound/compute_overall_level.md | 12 +- .../sound/compute_power_spectral_density.md | 14 +- ...e_prominence_ratio_for_orders_over_time.md | 12 +- .../sound/compute_roughness.md | 10 +- .../sound/compute_sharpness.md | 8 +- .../sound/compute_sharpness_din45692.md | 12 +- .../compute_sharpness_frequency_input.md | 8 +- .../sound/compute_sharpness_over_time.md | 10 +- .../compute_sound_power_level_iso3744.md | 24 ++-- .../sound/compute_spectral_centroid.md | 6 +- .../sound/compute_stft.md | 14 +- .../sound/compute_tonality_aures.md | 18 +-- .../sound/compute_tonality_din45681.md | 36 +++-- .../sound/compute_tonality_ecma418_2.md | 16 ++- .../sound/compute_tonality_iso1996_2.md | 23 +-- .../compute_tonality_iso1996_2_over_time.md | 30 ++-- .../sound/compute_tonality_isots_20065.md | 32 +++-- ...one_to_noise_ratio_for_orders_over_time.md | 12 +- .../sound/create_field_from_vector.md | 10 +- ...noise_profile_from_automatic_estimation.md | 8 +- ...create_noise_profile_from_noise_samples.md | 10 +- ...te_noise_profile_from_white_noise_power.md | 10 +- ...esign_minimum_phase_FIR_filter_from_FRF.md | 10 +- .../sound/filter_signal.md | 10 +- .../sound/get_cropped_signal.md | 10 +- .../sound/get_frequency_weighting.md | 51 +++++++ .../sound/isolate_orders.md | 18 +-- .../sound/load_FRF_from_txt.md | 6 +- .../load_project_sound_power_level_iso3744.md | 18 +-- .../sound/load_sound_samples_from_txt.md | 6 +- .../sound/load_wav_sas.md | 6 +- .../operator-specifications/sound/resample.md | 8 +- .../sound_composer_generate_sound_bbn.md | 10 +- ...poser_generate_sound_bbn_two_parameters.md | 12 +- ...sound_composer_generate_sound_harmonics.md | 10 +- ...generate_sound_harmonics_two_parameters.md | 12 +- .../sound_composer_generate_sound_spectrum.md | 12 +- .../sound/sound_composer_load_project.md | 8 +- .../sound/sound_composer_load_source_bbn.md | 6 +- ...composer_load_source_bbn_two_parameters.md | 6 +- .../sound_composer_load_source_harmonics.md | 6 +- ...er_load_source_harmonics_two_parameters.md | 6 +- .../sound_composer_load_source_spectrum.md | 6 +- .../sound/sound_composer_save_project.md | 8 +- .../sound/sum_signals.md | 6 +- .../sound/write_wav_sas.md | 8 +- .../operator-specifications/sound/xtract.md | 18 +-- .../sound/xtract_denoiser.md | 10 +- .../sound/xtract_tonal.md | 10 +- .../sound/xtract_transient.md | 10 +- .../utility/assemble_scalars_to_matrices.md | 24 ++-- .../assemble_scalars_to_matrices_fc.md | 24 ++-- .../utility/assemble_scalars_to_vectors.md | 10 +- .../utility/assemble_scalars_to_vectors_fc.md | 10 +- .../utility/bind_support.md | 8 +- .../utility/bind_support_fc.md | 8 +- .../utility/change_location.md | 8 +- .../utility/change_shell_layers.md | 14 +- .../utility/compute_time_scoping.md | 14 +- .../utility/customtypefield_get_attribute.md | 51 +++++++ .../utility/default_value.md | 2 +- .../utility/delegate_to_operator.md | 6 +- .../utility/ds_get_attribute.md | 14 +- .../utility/extract_field.md | 8 +- .../utility/extract_scoping.md | 9 +- .../utility/extract_sub_fc.md | 10 +- .../utility/extract_sub_mc.md | 10 +- .../utility/extract_sub_sc.md | 10 +- .../utility/extract_time_freq.md | 10 +- .../utility/fc_get_attribute.md | 10 +- .../operator-specifications/utility/field.md | 50 +++++++ .../utility/field_clone_to_shell_layer.md | 10 +- .../utility/field_get_attribute.md | 10 +- .../utility/field_to_fc.md | 8 +- .../utility/fields_container.md | 50 +++++++ .../utility/for_each.md | 6 +- .../utility/forward.md | 8 +- .../utility/forward_field.md | 6 +- .../utility/forward_fields_container.md | 6 +- .../utility/forward_meshes_container.md | 8 +- .../utility/hdf5dpf_workglow_provider.md | 14 +- .../utility/html_doc.md | 6 +- .../utility/incremental_concatenate_as_fc.md | 8 +- .../utility/ints_to_scoping.md | 8 +- .../utility/make_for_each_range.md | 8 +- .../utility/make_label_space.md | 10 +- .../utility/make_overall.md | 8 +- ...ake_producer_consumer_for_each_iterator.md | 16 +-- .../mechanical_make_time_chunk_for_each.md | 20 +-- ...l_make_time_freq_support_chunk_for_each.md | 20 +-- .../utility/merge_any.md | 8 +- .../utility/merge_collections.md | 8 +- .../utility/merge_data_tree.md | 8 +- .../utility/merge_fields.md | 12 +- .../utility/merge_fields_by_label.md | 14 +- .../merge_fields_container_matrices_label.md | 10 +- .../utility/merge_fields_containers.md | 16 +-- .../utility/merge_generic_data_container.md | 6 +- .../utility/merge_materials.md | 6 +- .../utility/merge_meshes.md | 18 +-- .../utility/merge_meshes_containers.md | 8 +- .../utility/merge_property_fields.md | 8 +- .../utility/merge_result_infos.md | 8 +- .../utility/merge_scopings.md | 6 +- .../utility/merge_scopings_containers.md | 6 +- .../utility/merge_string_fields.md | 6 +- .../utility/merge_supports.md | 8 +- .../utility/merge_time_freq_supports.md | 6 +- .../utility/merge_to_field_matrix.md | 6 +- .../utility/merge_weighted_fields.md | 12 +- .../merge_weighted_fields_containers.md | 16 +-- .../operator-specifications/utility/mesh.md | 50 +++++++ .../utility/mesh_to_mc.md | 8 +- .../utility/meshes_container.md | 50 +++++++ .../utility/operator_changelog.md | 50 +++++++ .../utility/operator_id.md | 6 +- .../utility/overlap_fields.md | 8 +- .../utility/producer_consumer_for_each.md | 4 +- .../utility/property_field.md | 50 +++++++ .../utility/propertyfield_get_attribute.md | 51 +++++++ .../utility/python_generator.md | 10 +- .../utility/remote_operator_instantiate.md | 18 +-- .../utility/remote_workflow_instantiate.md | 14 +- .../utility/remove_unnecessary_labels.md | 12 +- .../utility/scalars_to_field.md | 16 +-- .../utility/server_path.md | 6 +- .../utility/set_attribute.md | 10 +- .../utility/set_property.md | 14 +- .../utility/split_in_for_each_range.md | 10 +- .../utility/strain_from_voigt.md | 6 +- .../utility/strain_from_voigt_fc.md | 6 +- .../utility/txt_file_to_dpf.md | 6 +- .../utility/unitary_field.md | 6 +- .../utility/weighted_merge_fields_by_label.md | 14 +- 2026R1/dpf-framework-26-r1/toc.yml | 131 +++++++++++++++--- 899 files changed, 11257 insertions(+), 6884 deletions(-) create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization_fc.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/logic/solid_shell_fields.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_X.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XY.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XZ.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Y.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_YZ.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Z.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_eqv.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_intensity.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_max_shear.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_1.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_2.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_3.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/fluid_velocity.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_X.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XY.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XZ.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/modal_acceleration.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/modal_coordinate.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/modal_velocity.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_X.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Y.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Z.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_X.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_X.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Y.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Z.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_psd.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_psd_ansi_s1_11_1986.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_signal.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_psd.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_psd_ansi_s1_11_1986.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_signal.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/sound/get_frequency_weighting.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/utility/customtypefield_get_attribute.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/utility/field.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/utility/fields_container.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/utility/mesh.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/utility/meshes_container.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/utility/operator_changelog.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/utility/property_field.md create mode 100644 2026R1/dpf-framework-26-r1/operator-specifications/utility/propertyfield_get_attribute.md diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_difference.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_difference.md index cf1e28e135..77628575eb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_difference.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_difference.md @@ -16,22 +16,22 @@ Transforms an Elemental Nodal or Nodal field into an Elemental field. Each eleme | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | average only on these entities | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 10| through_layers |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The maximum elemental difference is taken through the different shell layers if true (default is false). | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | average only on these entities | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 10| through_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The maximum elemental difference is taken through the different shell layers if true (default is false). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_difference_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_difference_fc.md index b221d7a4dd..da89a581dd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_difference_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_difference_fc.md @@ -16,24 +16,24 @@ Transforms an Elemental Nodal or Nodal field into an Elemental field. Each eleme | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging, used if there is no fields support. | -| Pin 3| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Average only on these elements. If it is scoping container, the label must correspond to the one of the fields container. | -| Pin 10| collapse_shell_layers |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging, used if there is no fields support. | +| Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Average only on these elements. If it is scoping container, the label must correspond to the one of the fields container. | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_fraction_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_fraction_fc.md index 28606a08e1..6484c2dab1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_fraction_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_fraction_fc.md @@ -16,25 +16,25 @@ Transforms Elemental Nodal fields into Elemental fields. Each elemental value is | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | -| Pin 3| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. | -| Pin 6| denominator |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | If a fields container is set in this pin, it is used as the denominator of the fraction instead of entity_average_fc. | -| Pin 10| collapse_shell_layers |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | +| Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. | +| Pin 6| denominator |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | If a fields container is set in this pin, it is used as the denominator of the fraction instead of entity_average_fc. | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_mean.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_mean.md index 25f5e2c888..d79e46d8e6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_mean.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_mean.md @@ -16,22 +16,22 @@ Computes the average of a multi-entity field, (ElementalNodal -> Elemental), (No | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1| collapse_shell_layers |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, shell layers are averaged as well (default is false). | -| Pin 2| force_averaging |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true you average, if false you just sum. | -| Pin 3| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, shell layers are averaged as well (default is false). | +| Pin 2| force_averaging |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true you average, if false you just sum. | +| Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_mean_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_mean_fc.md index 11b36b0276..3b47db6747 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_mean_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_mean_fc.md @@ -16,25 +16,25 @@ Computes the average of a multi-entity container of fields, (ElementalNodal -> E | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| collapse_shell_layers |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | -| Pin 2| force_averaging |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true you average, if false you just sum. | -| Pin 3| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields container. | -| Pin 4| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | -| Pin 26| merge_solid_shell |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). This pin only has an effect when collapse_shell_layers is false and a value for e_shell_layer is provided. | -| Pin 27| e_shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 2| force_averaging |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true you average, if false you just sum. | +| Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields container. | +| Pin 4| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). This pin only has an effect when collapse_shell_layers is false and a value for e_shell_layer is provided. | +| Pin 27| e_shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal.md index 8eb9bfb686..2b3be2c402 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal.md @@ -16,25 +16,25 @@ Transforms an Elemental Nodal field into a Nodal field using an averaging proces | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | average only on these entities | -| Pin 2| should_average |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Each nodal value is divided by the number of elements linked to this node (default is true for discrete quantities). | -| Pin 4| extend_to_mid_nodes |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour primary nodes. | -| Pin 5| extend_weights_to_mid_nodes |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Extends weights to mid nodes (when available). Default is false. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | average only on these entities | +| Pin 2| should_average |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Each nodal value is divided by the number of elements linked to this node (default is true for discrete quantities). | +| Pin 4| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour primary nodes. | +| Pin 5| extend_weights_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Extends weights to mid nodes (when available). Default is false. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 1**| weight |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | Provides the number of times it was found in the elemental nodal field, for each node. Can be used to average later. | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 1**| weight |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Provides the number of times it was found in the elemental nodal field, for each node. Can be used to average later. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md index 916144b219..dcf9369612 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md @@ -16,20 +16,20 @@ Transforms an Elemental Nodal field to Nodal Elemental. The result is computed o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md index 03d00e2742..2924f6f0a2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md @@ -16,22 +16,22 @@ Transforms Elemental Nodal fields to Nodal Elemental fields. The result is compu | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md index 8474f5f2ae..8fa17fcb76 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md @@ -16,29 +16,29 @@ Transforms Elemental Nodal fields into Nodal fields using an averaging process. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | -| Pin 2| should_average |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Each nodal value is divided by the number of elements linked to this node (default is true for discrete quantities). | -| Pin 3| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Average only on these nodes. If it is a scoping container, the label must correspond to the one of the fields containers. | -| Pin 4| extend_to_mid_nodes |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour primary nodes. | -| Pin 5| extend_weights_to_mid_nodes |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Extends weights to mid nodes (when available). Default is false. | -| Pin 26| merge_solid_shell |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | +| Pin 2| should_average |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Each nodal value is divided by the number of elements linked to this node (default is true for discrete quantities). | +| Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Average only on these nodes. If it is a scoping container, the label must correspond to the one of the fields containers. | +| Pin 4| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour primary nodes. | +| Pin 5| extend_weights_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Extends weights to mid nodes (when available). Default is false. | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| weights |`class dataProcessing::DpfTypeCollection` | Gives for each node, the number of times it was found in the Elemental Nodal field. Can be used to average later. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| weights |class dataProcessing::DpfTypeCollection | Gives for each node, the number of times it was found in the Elemental Nodal field. Can be used to average later. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_elemental_nodal.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_elemental_nodal.md index 9a8fefa7ad..d63a3aa6b6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_elemental_nodal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_elemental_nodal.md @@ -16,21 +16,21 @@ Transforms an Elemental field to an Elemental Nodal field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | average only on these entities | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | average only on these entities | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md index c9f57ace4b..13b53065d6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md @@ -16,21 +16,21 @@ Transforms Elemental field to Elemental Nodal field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 3| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 3| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_nodal.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_nodal.md index 20eb54dc4c..6d828eaf2f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_nodal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_nodal.md @@ -25,23 +25,23 @@ Transforms an Elemental field to a Nodal field. The result is computed on a give | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| force_averaging |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Averaging on nodes is used if this pin is set to 1 (default is 1 for integrated results and 0 for discrete ones). | -| Pin 200| algorithm |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh). | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 2| force_averaging |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Averaging on nodes is used if this pin is set to 1 (default is 1 for integrated results and 0 for discrete ones). | +| Pin 200| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_nodal_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_nodal_fc.md index 9f7620a74b..76752b179a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_nodal_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_to_nodal_fc.md @@ -23,25 +23,25 @@ Transforms Elemental Nodal fields to Nodal fields. The result is computed on a g | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 2| force_averaging |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Averaging on nodes is used if this pin is set to 1 (default is 1 for integrated results and 0 for discrete ones). | -| Pin 3| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | | -| Pin 200| algorithm |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 2| force_averaging |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Averaging on nodes is used if this pin is set to 1 (default is 1 for integrated results and 0 for discrete ones). | +| Pin 3| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | +| Pin 200| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/extend_to_mid_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/extend_to_mid_nodes.md index 45ec00d2d1..f9c2727399 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/extend_to_mid_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/extend_to_mid_nodes.md @@ -16,21 +16,21 @@ Extends an Elemental Nodal or Nodal field defined on corner nodes to a field def | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/extend_to_mid_nodes_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/extend_to_mid_nodes_fc.md index 3c5dc27a45..7c1956d7a7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/extend_to_mid_nodes_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/extend_to_mid_nodes_fc.md @@ -16,23 +16,23 @@ Extends Elemental Nodal or Nodal fields defined on corner nodes to Elemental Nod | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation.md index 1b1475e3fe..27617b61cb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation.md @@ -16,30 +16,30 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | default = all time steps | -| Pin 1| nodal_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes) | -| Pin 2| elemental_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Elemental Scoping. Set of elements contributing to the force calcuation. (default = all elements) | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Streams container. Optional if using data sources. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data sources. Optional if using a streams container. | -| Pin 5| force_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Type of force to be processed (0 - default: Total forces (static, damping, and inertia)., 1: Static forces, 2: Damping forces, 3: Inertia forces) | -| Pin 6| spoint |[`field`](./../../core-concepts/dpf-types.md#field) | Coordinate field of a point for moment summations. Defaults to (0,0,0). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | default = all time steps | +| Pin 1| nodal_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes) | +| Pin 2| elemental_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental Scoping. Set of elements contributing to the force calcuation. (default = all elements) | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams container. Optional if using data sources. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources. Optional if using a streams container. | +| Pin 5| force_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Type of force to be processed (0 - default: Total forces (static, damping, and inertia)., 1: Static forces, 2: Damping forces, 3: Inertia forces) | +| Pin 6| spoint |[`field`](../../core-concepts/dpf-types.md#field) | Coordinate field of a point for moment summations. Defaults to (0,0,0). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| force_accumulation |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| moment_accumulation |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 2**| heat_accumulation |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 10**| forces_on_nodes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 11**| moments_on_nodes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 12**| heats_on_nodes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| force_accumulation |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| moment_accumulation |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 2**| heat_accumulation |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 10**| forces_on_nodes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 11**| moments_on_nodes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 12**| heats_on_nodes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation_psd.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation_psd.md index 72ebd663fe..1645d37730 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation_psd.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation_psd.md @@ -16,28 +16,28 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| nodal_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes. | -| Pin 2| elemental_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Elemental Scoping. Set of elements contributing to the force calculation. Defaults to all elements. | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Streams container for RST and PSD files (optional if using data sources). The operator supports both a single RST file and two separate RST files. See data sources pin specifications for details on how to define the streams for both cases. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data sources containing RST and PSD files (optional if using a streams container). The operator supports both a single RST file (containing both modal and PSD results) and two separate RST files (one for modal and one for PSD analyses).The data source containing modal results must be defined as an upstream data source.If using a single RST file for PSD and modal analysis, the RST file must be in an upstream data source.If using two separate RST files, only the modal RST must be in an upstream data source. | -| Pin 6| spoint |[`field`](./../../core-concepts/dpf-types.md#field) | Coordinate field of a point for moment summations. Defaults to (0,0,0). | -| Pin 7| abs_rel_key |[`field`](./../../core-concepts/dpf-types.md#field) | Key to select the type of response: 0 for relative response (default) or 1 for absolute response. | -| Pin 8| signif |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Significance threshold, defaults to 0.0001. Any mode with a significance level above this value will be included in the combination.The significance level is defined as the modal covariance matrix term, divided by the maximum modal covariance matrix term. | +| Pin 1| nodal_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes. | +| Pin 2| elemental_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental Scoping. Set of elements contributing to the force calculation. Defaults to all elements. | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams container for RST and PSD files (optional if using data sources). The operator supports both a single RST file and two separate RST files. See data sources pin specifications for details on how to define the streams for both cases. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources containing RST and PSD files (optional if using a streams container). The operator supports both a single RST file (containing both modal and PSD results) and two separate RST files (one for modal and one for PSD analyses).The data source containing modal results must be defined as an upstream data source.If using a single RST file for PSD and modal analysis, the RST file must be in an upstream data source.If using two separate RST files, only the modal RST must be in an upstream data source. | +| Pin 6| spoint |[`field`](../../core-concepts/dpf-types.md#field) | Coordinate field of a point for moment summations. Defaults to (0,0,0). | +| Pin 7| abs_rel_key |[`field`](../../core-concepts/dpf-types.md#field) | Key to select the type of response: 0 for relative response (default) or 1 for absolute response. | +| Pin 8| signif |[`double`](../../core-concepts/dpf-types.md#standard-types) | Significance threshold, defaults to 0.0001. Any mode with a significance level above this value will be included in the combination.The significance level is defined as the modal covariance matrix term, divided by the maximum modal covariance matrix term. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| force_accumulation |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Returns the sum of forces for the 1-sigma displacement solution on the scoped nodes/elements. | -| **Pin 1**| moment_accumulation |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Returns the sum of moments for the 1-sigma displacement solution on the scoped nodes/elements. | -| **Pin 10**| forces_on_nodes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Returns the nodal forces for the 1-sigma displacement solution on the scoped nodes/elements. | -| **Pin 11**| moments_on_nodes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Returns the nodal moments for the 1-sigma displacement solution on the scoped nodes/elements. | +| **Pin 0**| force_accumulation |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Returns the sum of forces for the 1-sigma displacement solution on the scoped nodes/elements. | +| **Pin 1**| moment_accumulation |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Returns the sum of moments for the 1-sigma displacement solution on the scoped nodes/elements. | +| **Pin 10**| forces_on_nodes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Returns the nodal forces for the 1-sigma displacement solution on the scoped nodes/elements. | +| **Pin 11**| moments_on_nodes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Returns the nodal moments for the 1-sigma displacement solution on the scoped nodes/elements. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/gauss_to_node_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/gauss_to_node_fc.md index 8876b28a58..fbe44365c2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/gauss_to_node_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/gauss_to_node_fc.md @@ -16,21 +16,21 @@ Extrapolates results available at Gauss or quadrature points to nodal points for | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used for extrapolating results available at Gauss or quadrature points to nodal points. | -| Pin 3| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Extrapolating results on the selected scoping. If it is a scoping container, the label must correspond to the one of the fields containers. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used for extrapolating results available at Gauss or quadrature points to nodal points. | +| Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Extrapolating results on the selected scoping. If it is a scoping container, the label must correspond to the one of the fields containers. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_difference.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_difference.md index 0bbb8ffc3f..cec8de6b95 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_difference.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_difference.md @@ -16,21 +16,21 @@ Transforms an Elemental Nodal field into a Nodal field. Each nodal value is the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | average only on these entities | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | average only on these entities | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_difference_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_difference_fc.md index 5752429fc5..669ab6e842 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_difference_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_difference_fc.md @@ -16,23 +16,23 @@ Transforms Elemental Nodal fields into Nodal fields. Each nodal value is the max | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | -| Pin 3| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Average only on these nodes. If it is a scoping container, the label must correspond to the one of the fields containers. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | +| Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Average only on these nodes. If it is a scoping container, the label must correspond to the one of the fields containers. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_fraction_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_fraction_fc.md index fbc9942b61..d84469923a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_fraction_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_fraction_fc.md @@ -16,24 +16,24 @@ Transforms Elemental Nodal fields into Nodal fields. Each nodal value is the fra | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | -| Pin 3| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Average only on these nodes. If it is a scoping container, the label must correspond to the one of the fields containers. | -| Pin 6| denominator |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | If a fields container is set in this pin, it is used as the denominator of the fraction instead of elemental_nodal_To_nodal_fc. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | +| Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Average only on these nodes. If it is a scoping container, the label must correspond to the one of the fields containers. | +| Pin 6| denominator |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | If a fields container is set in this pin, it is used as the denominator of the fraction instead of elemental_nodal_To_nodal_fc. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental.md index f910f0c6ff..6057e86286 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental.md @@ -16,21 +16,21 @@ Transforms a Nodal field to an Elemental field, The result is computed on a give | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 10| collapse_shell_layers |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_fc.md index bfbce4fa6a..46507b4084 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_fc.md @@ -16,26 +16,26 @@ Transforms Nodal fields into Elemental fields using an averaging process. The re | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | -| Pin 3| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. | -| Pin 10| collapse_shell_layers |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | -| Pin 26| merge_solid_shell |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | +| Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_nodal.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_nodal.md index 205783a198..5bfe9ee8d0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_nodal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_nodal.md @@ -16,21 +16,21 @@ Transforms a Nodal field to an ElementalNodal field, The result is computed on a | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 10| collapse_shell_layers |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md index c0fb5bc852..68fea1e99f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md @@ -16,21 +16,21 @@ Transforms Nodal fields_container to Elemental Nodal fields_container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 3| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 3| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_elemental_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_elemental_fc.md index f5d293c404..4fec6cdd56 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_elemental_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_elemental_fc.md @@ -16,27 +16,27 @@ Transforms Input fields into Elemental fields using an averaging process. The re | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 3| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 7| smoothen_values |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if it is set to true, Elemental Nodal fields are first averaged on nodes and then averaged on elements (default is false). | -| Pin 10| collapse_shell_layers |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | -| Pin 26| merge_solid_shell |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 3| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 7| smoothen_values |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if it is set to true, Elemental Nodal fields are first averaged on nodes and then averaged on elements (default is false). | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_elemental_nodal_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_elemental_nodal_fc.md index 87b16133f2..d84abd713d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_elemental_nodal_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_elemental_nodal_fc.md @@ -16,23 +16,23 @@ Transforms fields into Elemental Nodal fields using an averaging process. The re | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_nodal.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_nodal.md index 4e18108770..f47f187f11 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_nodal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_nodal.md @@ -16,22 +16,22 @@ Transforms a field into a Nodal field using an averaging process. The result is | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 26| merge_solid_shell |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_nodal_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_nodal_fc.md index 5ee96cee30..6e7b87fef7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_nodal_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/to_nodal_fc.md @@ -16,25 +16,25 @@ Transforms fields into Nodal fields using an averaging process. The result is co | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 3| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 26| merge_solid_shell |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 3| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/add_default_data.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/add_default_data.md index 0aad4e5289..5bc03a876e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/add_default_data.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/add_default_data.md @@ -16,10 +16,10 @@ Adds the defaults to the elements which were removed by the lay-up provider from | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | requested_time_id | -| Pin 1
Required| requested_element_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | requested_element_scoping | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh | -| Pin 300
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields container to which default values are added | +| Pin 0
Required| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | requested_time_id | +| Pin 1
Required| requested_element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | requested_element_scoping | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh | +| Pin 300
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields container to which default values are added | ## Outputs @@ -30,7 +30,7 @@ Adds the defaults to the elements which were removed by the lay-up provider from | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_failure_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_failure_operator.md index 71e820c8e5..4a4cfa1dab 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_failure_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_failure_operator.md @@ -16,24 +16,24 @@ Uses json failure configuration to compute evaluate composite failure criterion. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 100
Required| result_definition |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Combined failure criterion configuration (string of json dict) | -| Pin 310| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](./../../core-concepts/dpf-types.md#result-info), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 100
Required| result_definition |[`string`](../../core-concepts/dpf-types.md#standard-types) | Combined failure criterion configuration (string of json dict) | +| Pin 310| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_containerMin |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the minimal failure value results. Contains data for the failure value,failure mode and layer index | -| **Pin 1**| fields_containerMax |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the maximum failure value results. Contains data for the failure value,failure mode and layer index | -| **Pin 2**| fields_containerMin_ref_surface |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the minimum failure value results. Contains data for the failure value,failure mode, global stack index, per element stack index and solid element id | -| **Pin 3**| fields_containerMax_ref_surface |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the maximum failure value results. Contains data for the failure value,failure mode, global stack index, per element stack index and solid element id | -| **Pin 402**| cache_status |[`data_tree`](./../../core-concepts/dpf-types.md#data-tree) | Cache status for the different inputs. A data tree with the attributes: rst_data_source, default_unit_system, layup_data_source, engineering_data_source, material_support and ref_surface_unit_system. Each attribute is an int that is 1 if the cache was hit and 0 if not. | +| **Pin 0**| fields_containerMin |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the minimal failure value results. Contains data for the failure value,failure mode and layer index | +| **Pin 1**| fields_containerMax |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the maximum failure value results. Contains data for the failure value,failure mode and layer index | +| **Pin 2**| fields_containerMin_ref_surface |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the minimum failure value results. Contains data for the failure value,failure mode, global stack index, per element stack index and solid element id | +| **Pin 3**| fields_containerMax_ref_surface |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the maximum failure value results. Contains data for the failure value,failure mode, global stack index, per element stack index and solid element id | +| **Pin 402**| cache_status |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | Cache status for the different inputs. A data tree with the attributes: rst_data_source, default_unit_system, layup_data_source, engineering_data_source, material_support and ref_surface_unit_system. Each attribute is an int that is 1 if the cache was hit and 0 if not. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_field_variable_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_field_variable_operator.md index b889de403a..e303a619d5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_field_variable_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_field_variable_operator.md @@ -16,11 +16,11 @@ Enriches the materials container with the material fields (field variable) from | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 22
Required| material_fields |`umap` | | -| Pin 23
Required| materials_container |`materials_container` | | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 22
Required| material_fields |umap | | +| Pin 23
Required| materials_container |materials_container | | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -31,7 +31,7 @@ Enriches the materials container with the material fields (field variable) from | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_scoping_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_scoping_operator.md index 0f44130dbd..7c09268b0f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_scoping_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_scoping_operator.md @@ -16,9 +16,9 @@ Computes scoping based on ply and element scope | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1
Required| element_scope |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Optional: CScoping with selected element ids. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 105
Required| ply_scope |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Optional: vector of selected ply ids. | +| Pin 1
Required| element_scope |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Optional: CScoping with selected element ids. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 105
Required| ply_scope |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Optional: vector of selected ply ids. | ## Outputs @@ -29,7 +29,7 @@ Computes scoping based on ply and element scope | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/convert_sampling_point_to_json.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/convert_sampling_point_to_json.md index 358ad59dca..4d4006f65c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/convert_sampling_point_to_json.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/convert_sampling_point_to_json.md @@ -16,19 +16,19 @@ Converts a sampling point object into a sampling point json string. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| sampling_point |`struct dataProcessing::composite::sampling_point::SamplingPoint` | Sampling Point | +| Pin 0
Required| sampling_point |struct dataProcessing::composite::sampling_point::SamplingPoint | Sampling Point | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| string |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Sampling point json | +| **Pin 0**| string |[`string`](../../core-concepts/dpf-types.md#standard-types) | Sampling point json | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/core_shear_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/core_shear_operator.md index 2e83ed41e9..10034d9d8a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/core_shear_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/core_shear_operator.md @@ -16,24 +16,24 @@ Computes Core Shear for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "include_ins" : true, "wf" : 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'orthotropic_homogeneous_core', 'isotropic_homogeneous_core', 'honeycomb_core' | -| Pin 102
Required| mesh |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "include_ins" : true, "wf" : 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'orthotropic_homogeneous_core', 'isotropic_homogeneous_core', 'honeycomb_core' | +| Pin 102
Required| mesh |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/cuntze_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/cuntze_operator.md index 2bc101b5f5..e0c339d710 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/cuntze_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/cuntze_operator.md @@ -16,25 +16,25 @@ Computes Cuntze's failure criterion for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"b21": 0.2, "b32": 1.38, "cfc": true, "cft": true, "cma": true, "cmb": true, "cmc": true, "dim": 2, "fracture_plane_angle": 53, "mode_interaction_coeff": 2.6, "wf_cfc": 1, "wf_cft": 1, "wf_cma": 1, "wf_cmb": 1, "wf_cmc": 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 400
Required| strains_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"b21": 0.2, "b32": 1.38, "cfc": true, "cft": true, "cma": true, "cmb": true, "cmc": true, "dim": 2, "fracture_plane_angle": 53, "mode_interaction_coeff": 2.6, "wf_cfc": 1, "wf_cft": 1, "wf_cma": 1, "wf_cmb": 1, "wf_cmc": 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_failure_criterion_per_scope.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_failure_criterion_per_scope.md index b3e778d14f..e423b5dca5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_failure_criterion_per_scope.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_failure_criterion_per_scope.md @@ -16,34 +16,34 @@ Evaluates failure criteria for a specified scope. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1
Required| element_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Element scoping on which failure criteria are evaluated | -| Pin 3
Required| stream_provider |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Stream with result file. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh (including layup information if available) | -| Pin 22| material_fields |`umap` | Material fields: Only needed if has_layup_provider is true | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 24| section_data_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Section Data Container: Only needed if has_layup_provider is true | -| Pin 25| mesh_properties_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Mesh Properties Container Container: Only needed if has_layup_provider is true | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Failure criteria configuration | -| Pin 217
Required| has_layup_provider |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Deprecated since 2024 R2. Use input pin 218instead. Should be set to true if layup information is available. Equivalent new input is ACP (1). | -| Pin 218
Required| layup_model_context_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Define the source of section data. Values are: 0=not available, 1=ACP, 2=RST, 3=MIXED (ACP+RST). | -| Pin 302
Required| request_sandwich_results |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Request results for sandwich failure criteria. | -| Pin 303| use_live_evaluation |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Use live evaluation. Default: False | -| Pin 307
Required| scope_configuration |`struct dataProcessing::composite::CompositeScopeConfig` | Scope configuration | +| Pin 1
Required| element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Element scoping on which failure criteria are evaluated | +| Pin 3
Required| stream_provider |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Stream with result file. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh (including layup information if available) | +| Pin 22| material_fields |umap | Material fields: Only needed if has_layup_provider is true | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 24| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section Data Container: Only needed if has_layup_provider is true | +| Pin 25| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mesh Properties Container Container: Only needed if has_layup_provider is true | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Failure criteria configuration | +| Pin 217
Required| has_layup_provider |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Deprecated since 2024 R2. Use input pin 218instead. Should be set to true if layup information is available. Equivalent new input is ACP (1). | +| Pin 218
Required| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Define the source of section data. Values are: 0=not available, 1=ACP, 2=RST, 3=MIXED (ACP+RST). | +| Pin 302
Required| request_sandwich_results |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Request results for sandwich failure criteria. | +| Pin 303| use_live_evaluation |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Use live evaluation. Default: False | +| Pin 307
Required| scope_configuration |struct dataProcessing::composite::CompositeScopeConfig | Scope configuration | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 304**| failure_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container with the failure results | -| **Pin 306**| time_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Requested time id | -| **Pin 400**| strains_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container with the strains | -| **Pin 401**| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container with the stresses | +| **Pin 304**| failure_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container with the failure results | +| **Pin 306**| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Requested time id | +| **Pin 400**| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container with the strains | +| **Pin 401**| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container with the stresses | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_sampling_point.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_sampling_point.md index c1d0347ca3..fdbba5a699 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_sampling_point.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_sampling_point.md @@ -16,30 +16,31 @@ Creates a sampling point object. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1
Required| element_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Element scoping | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh | -| Pin 21
Required| material_support |`abstract_field_support` | Material Support | -| Pin 23
Required| materials_container |`materials_container` | Materials Container | -| Pin 24
Required| section_data_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Section data container | -| Pin 304
Required| failure_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container that contains the failure values | -| Pin 306
Required| time_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | requested_time_id | -| Pin 308
Required| extract_max_failure_per_layer |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, extract maximum failure value per layer. Otherwise get max values per spot. | -| Pin 309
Required| check_mechanical_unit_system |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Check mechancial unit system. If true, checks that unit system is supported by mechanical | -| Pin 310
Required| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](./../../core-concepts/dpf-types.md#result-info), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types) | Unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | -| Pin 400
Required| strains_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Strains Container | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Stresses Container | +| Pin 1
Required| element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Element scoping | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh | +| Pin 21
Required| material_support |abstract_field_support | Material Support | +| Pin 23
Required| materials_container |materials_container | Materials Container | +| Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section data container | +| Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to get the sampling point for solid models. Not needed for shells. | +| Pin 304
Required| failure_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container that contains the failure values | +| Pin 306
Required| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | requested_time_id | +| Pin 308
Required| extract_max_failure_per_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, extract maximum failure value per layer. Otherwise get max values per spot. | +| Pin 309
Required| check_mechanical_unit_system |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Check mechancial unit system. If true, checks that unit system is supported by mechanical | +| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Strains Container | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Stresses Container | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| struct dataProcessing::composite::sampling_point::SamplingPoint |`struct dataProcessing::composite::sampling_point::SamplingPoint` | Sampling Point | +| **Pin 0**| struct dataProcessing::composite::sampling_point::SamplingPoint |struct dataProcessing::composite::sampling_point::SamplingPoint | Sampling Point | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/face_sheet_wrinkling_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/face_sheet_wrinkling_operator.md index 3ee69a011f..050b4351b0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/face_sheet_wrinkling_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/face_sheet_wrinkling_operator.md @@ -16,25 +16,25 @@ Computes face-sheet wrinkling criterion for layered elements. Use the composite: | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 24
Required| section_data_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Layup Container with layer thicknesses, angles etc. | -| Pin 25
Required| mesh_property_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to compute Wrinkling for solids. Not needed to compute wrinkling for shells. | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"homogeneous_core_coeff" : 0.5, "honeycomb_core_coeff" : 0.33, "wf" : 1.0} | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Layup Container with layer thicknesses, angles etc. | +| Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to compute Wrinkling for solids. Not needed to compute wrinkling for shells. | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"homogeneous_core_coeff" : 0.5, "honeycomb_core_coeff" : 0.33, "wf" : 1.0} | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/failure_measure_converter.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/failure_measure_converter.md index 23b476348e..d14a4f7a40 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/failure_measure_converter.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/failure_measure_converter.md @@ -16,20 +16,20 @@ Conversion from one failure measure to another. Supported are inverse_reserve_fa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| measure_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | measure type: can be `inverse_reserve_factor` (default), `safety_factor` or `safety_margin`. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| measure_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | measure type: can be `inverse_reserve_factor` (default), `safety_factor` or `safety_margin`. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The converted input FieldsContainer. It is the same instance/pointer. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The converted input FieldsContainer. It is the same instance/pointer. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/filter_ply_data_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/filter_ply_data_operator.md index 88065a8a23..16fd90f8f4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/filter_ply_data_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/filter_ply_data_operator.md @@ -16,22 +16,22 @@ Selects a ply from layered elemental_nodal data and averages the data over the s | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | Elemental Nodal input field with layered data. Example are stress and strains fields as read from the rst file. | -| Pin 1
Required| ply_id |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Ply Id of the analysis ply that gets selected. | -| Pin 2
Required| reduction_strategy |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Reduction strategy for spot data (bot, mid, top) values. Available options: - AVG: average over spots (default) - MIN: take minimum value of all spots - MAX: take maximum value of all spots - BOT: take bottom value (only supported for shell elements if at least two spots are available in the output) - MID: take mid value (only supported for shell elements if at least three spots are available in the output) - TOP: take top value (only supported for shell elements if at least two spots are available in the output) | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed region with composite information. The mesh needs to have property field with the name 'element_layer_indices' whichcontains the number of layers for each element. It also needs to have a field with the name AnalysisPly::ply_id where ply_id is the ply_id as defined by pin 1. These two property fields are automatically added to the meshed region if the 'composite::layup_provider_operator'is run. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | Elemental Nodal input field with layered data. Example are stress and strains fields as read from the rst file. | +| Pin 1
Required| ply_id |[`string`](../../core-concepts/dpf-types.md#standard-types) | Ply Id of the analysis ply that gets selected. | +| Pin 2
Required| reduction_strategy |[`string`](../../core-concepts/dpf-types.md#standard-types) | Reduction strategy for spot data (bot, mid, top) values. Available options: - AVG: average over spots (default) - MIN: take minimum value of all spots - MAX: take maximum value of all spots - BOT: take bottom value (only supported for shell elements if at least two spots are available in the output) - MID: take mid value (only supported for shell elements if at least three spots are available in the output) - TOP: take top value (only supported for shell elements if at least two spots are available in the output) | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed region with composite information. The mesh needs to have property field with the name 'element_layer_indices' whichcontains the number of layers for each element. It also needs to have a field with the name AnalysisPly::ply_id where ply_id is the ply_id as defined by pin 1. These two property fields are automatically added to the meshed region if the 'composite::layup_provider_operator'is run. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | Output field | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | Output field | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/get_field_properties_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/get_field_properties_operator.md index c2b7d51032..1ef2402953 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/get_field_properties_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/get_field_properties_operator.md @@ -10,25 +10,25 @@ license: None ## Description -Operator which returns all int, double and string properties as a data tree. Input can be a CField or CPropertyField. The purpose of this operator is to expose the properties in python. So the operator will be removed once this is available natively or it has been replicated in DPF Core. +Deprecated since 2026 R1! Use 'field::get_attribute' or 'propertyfield::get_attribute' with pin 1 equals 'header' instead. Operator which returns all int, double and string properties as a data tree. Input can be a CField or CPropertyField. The purpose of this operator is to expose the properties in python. So the operator will be removed once this is available natively or it has been replicated in DPF Core. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| field |[`field`](./../../core-concepts/dpf-types.md#field), [`property_field`](./../../core-concepts/dpf-types.md#property-field) | C(Property)Field. | +| Pin 0| field |[`field`](../../core-concepts/dpf-types.md#field), [`property_field`](../../core-concepts/dpf-types.md#property-field) | C(Property)Field. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| properties |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | DataTree with all properties | +| **Pin 0**| properties |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | DataTree with all properties | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hashin_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hashin_operator.md index 596634d9da..cfc1e48623 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hashin_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hashin_operator.md @@ -16,24 +16,24 @@ Computes hashin criterion for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": false, "dim" : 2, "hd" : false, "hf" : true, "hm" : true, "wf_hd" : 1, "wf_hf" : 1, "wf_hm" : 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'regular'. | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Stress field | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": false, "dim" : 2, "hd" : false, "hf" : true, "hm" : true, "wf_hd" : 1, "wf_hf" : 1, "wf_hm" : 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'regular'. | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Stress field | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hill_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hill_operator.md index f057d1cd8d..0e2c44bb02 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hill_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hill_operator.md @@ -16,24 +16,24 @@ Computes Hill for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification: For instance `{'active': true, 'dim': 2, 'wf': 1}` | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Stress container | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification: For instance `{'active': true, 'dim': 2, 'wf': 1}` | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Stress container | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hoffman_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hoffman_operator.md index d36011b098..818d725cb5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hoffman_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hoffman_operator.md @@ -16,24 +16,24 @@ Computes Hoffman for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/inistate_field_variable_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/inistate_field_variable_operator.md index fa581ca390..f1eccff5bf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/inistate_field_variable_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/inistate_field_variable_operator.md @@ -16,22 +16,22 @@ Extracts field variables from an APDL input file (dat) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| stress_field |[`field`](./../../core-concepts/dpf-types.md#field) | An optional stress field to be specified when using the field variables for the evaluation of failure criteria. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | An APDL input file written by Ansys Mechanical. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| stress_field |[`field`](../../core-concepts/dpf-types.md#field) | An optional stress field to be specified when using the field variables for the evaluation of failure criteria. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | An APDL input file written by Ansys Mechanical. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing the field variables. | -| **Pin 1**| property_fields_container |[`property_fields_container`](./../../core-concepts/dpf-types.md#property-fields-container) | A CPropertyFieldsContainer containing the field variables mapping support. Only available when the optional stress field was specified. Check for nullptr! | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing the field variables. | +| **Pin 1**| property_fields_container |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | A CPropertyFieldsContainer containing the field variables mapping support. Only available when the optional stress field was specified. Check for nullptr! | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/interlaminar_normal_stress_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/interlaminar_normal_stress_operator.md index b55bcc7451..ed8fb22d18 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/interlaminar_normal_stress_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/interlaminar_normal_stress_operator.md @@ -16,13 +16,13 @@ Computes the interlaminar normal stresses and updates the stress container | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |`materials_container` | Materials Container | -| Pin 24
Required| section_data_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Section data fields container | -| Pin 25
Required| mesh_properties_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Mesh property fields container | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Whether to check if all the inputs have the same meshed region. This check can become expensive | -| Pin 400
Required| strains_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Strains | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Stresses | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | +| Pin 23
Required| materials_container |materials_container | Materials Container | +| Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section data fields container | +| Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mesh property fields container | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Whether to check if all the inputs have the same meshed region. This check can become expensive | +| Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Strains | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Stresses | ## Outputs @@ -33,7 +33,7 @@ Computes the interlaminar normal stresses and updates the stress container | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/larc_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/larc_operator.md index d49d231eb8..643cf48ca8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/larc_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/larc_operator.md @@ -16,26 +16,26 @@ Computes Larc for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 24
Required| section_data_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Layup Container with layer thicknesses, angles etc. | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"active": True, "dim" : 2, "lfc" : True, "lft" : True, "lmc" : True, "lmt" : True, "wf_lfc" : 1, "wf_lft" : 1, "wf_lmc" : 1, "wf_lmt" : 1} | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | -| Pin 102
Required| bool |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 400
Required| strains_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Layup Container with layer thicknesses, angles etc. | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"active": True, "dim" : 2, "lfc" : True, "lft" : True, "lmc" : True, "lmt" : True, "wf_lfc" : 1, "wf_lft" : 1, "wf_lmc" : 1, "wf_lmt" : 1} | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | +| Pin 102
Required| bool |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/layup_provider_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/layup_provider_operator.md index fac13ba316..2f79db40b9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/layup_provider_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/layup_provider_operator.md @@ -16,27 +16,28 @@ Import section data from ACP's composite definition files and/or | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3
Required| rst_stream |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Stream of the RST file(s). Set this input to import section data from this source. Elements with section data from data_sources are skipped. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | DataSource of composite definitions (h5) files with mapping files to import lay-up information with additional ACP specific information. Use the sResultKey to name the parts. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 21
Required| abstract_field_support |`abstract_field_support` | The material support originating from an RST file. | -| Pin 310
Required| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](./../../core-concepts/dpf-types.md#result-info), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types) | Layup quantities are converted into this unit system. Can be unit system object, result_info object int or string. In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 3
Required| rst_stream |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Stream of the RST file(s). Set this input to import section data from this source. Elements with section data from data_sources are skipped. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | DataSource of composite definitions (h5) files with mapping files to import lay-up information with additional ACP specific information. Use the sResultKey to name the parts. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 21
Required| abstract_field_support |abstract_field_support | The material support originating from an RST file. | +| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Layup quantities are converted into this unit system. Can be unit system object, result_info object int or string. In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 500
Required| skip_reinforcing_plies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The post-processing of reinforcing plies is not supported and so an error is thrown by default if such entities are found. Set 'skip_reinforcing_plies' to true to ignore them and to process the layered elements. Note that it is planned to support reinforcing elements and then this input will be removed again. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| update |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Request this output to run the operator. Returns always true. Only useful in a workflow context whereexplicit runs are not possible. | -| **Pin 22**| material_fields |`umap` | A unordered map with key the variable material field name and value the corresponding ImportedMaterialField struct. | -| **Pin 24**| section_data_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing the angles, the thicknesses and the laminate offset of each layer. | -| **Pin 25**| mesh_properties_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing mesh properties (curvature, element edge length etc.). Only available if composite definitions are passed to the input. | -| **Pin 218**| layup_model_context_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Returns the type of lay-up model. 0=Not available, 1=ACP, 2=RST, 3=Mixed. Mixed means that section data from ACP and the RST file were imported. | +| **Pin 0**| update |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Request this output to run the operator. Returns always true. Only useful in a workflow context whereexplicit runs are not possible. | +| **Pin 22**| material_fields |umap | A unordered map with key the variable material field name and value the corresponding ImportedMaterialField struct. | +| **Pin 24**| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing the angles, the thicknesses and the laminate offset of each layer. | +| **Pin 25**| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing mesh properties (curvature, element edge length etc.). Only available if composite definitions are passed to the input. | +| **Pin 218**| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Returns the type of lay-up model. 0=Not available, 1=ACP, 2=RST, 3=Mixed. Mixed means that section data from ACP and the RST file were imported. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_keyword_parser.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_keyword_parser.md index c3eee2f278..2d74586005 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_keyword_parser.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_keyword_parser.md @@ -25,20 +25,20 @@ Reads a specific keyword from an k-file. The parser reads the name of the option | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| keyword |[`string`](./../../core-concepts/dpf-types.md#standard-types) | The keyword of interest. For instance '*DATABASE_EXTENT_BINARY'. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | LS Dyna input file (*.k) as data source. Use LsDynaInputFile as key to add a k-file to the DataSources object. | +| Pin 0
Required| keyword |[`string`](../../core-concepts/dpf-types.md#standard-types) | The keyword of interest. For instance '*DATABASE_EXTENT_BINARY'. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | LS Dyna input file (*.k) as data source. Use LsDynaInputFile as key to add a k-file to the DataSources object. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| keyword_options |[`string`](./../../core-concepts/dpf-types.md#standard-types) | JSON string with all the options. For instance '{"neiph": 0, "neips": 16, ...}' | +| **Pin 0**| keyword_options |[`string`](../../core-concepts/dpf-types.md#standard-types) | JSON string with all the options. For instance '{"neiph": 0, "neips": 16, ...}' | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_material_support_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_material_support_provider.md index 44a8f94b3a..2c7bdab54e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_material_support_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_material_support_provider.md @@ -16,19 +16,19 @@ Extracts the material IDs and VUUIDs from a k file and provides a material suppo | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | LS Dyna input file (*.k) as data source. Use LsDynaInputFile as key to add a k-file to the DataSources object. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | LS Dyna input file (*.k) as data source. Use LsDynaInputFile as key to add a k-file to the DataSources object. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| abstract_field_support |`abstract_field_support` | Material support (CFieldSupportBase). | +| **Pin 0**| abstract_field_support |abstract_field_support | Material support (CFieldSupportBase). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_preparing_results.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_preparing_results.md index 02d9e28fa8..a43b8317d1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_preparing_results.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_preparing_results.md @@ -16,21 +16,21 @@ Remove unused result (integration points).The number of integration points in th | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| maxint |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | The value of MAXINT. | -| Pin 2
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Result container. For instance strains or stresses. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Enriched meshed region with section information such as number of layers. See 'composite::layup_provider_operator' for more information. | +| Pin 0
Required| maxint |[`int32`](../../core-concepts/dpf-types.md#standard-types) | The value of MAXINT. | +| Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Result container. For instance strains or stresses. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Enriched meshed region with section information such as number of layers. See 'composite::layup_provider_operator' for more information. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container with the prepared results. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container with the prepared results. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/map_to_reference_surface_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/map_to_reference_surface_operator.md index 495e01c497..b3c340e761 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/map_to_reference_surface_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/map_to_reference_surface_operator.md @@ -16,24 +16,24 @@ Maps values from a min and max field container, according to a mapping defined i | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mapping_field |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | Mapping property field. Contains a list of ids for every entity. | -| Pin 1
Required| min_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Min fields container. Container that contains value, mode and layer index field with the minimum values. | -| Pin 2
Required| max_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Max fields container. Container that contains value, mode and layer index field with the maximum values. | -| Pin 3
Required| layers_per_element |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | Property field that contains the number of layers for each element. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed region of reference surface. Used as the support for the output fields. | +| Pin 0
Required| mapping_field |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Mapping property field. Contains a list of ids for every entity. | +| Pin 1
Required| min_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Min fields container. Container that contains value, mode and layer index field with the minimum values. | +| Pin 2
Required| max_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Max fields container. Container that contains value, mode and layer index field with the maximum values. | +| Pin 3
Required| layers_per_element |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Property field that contains the number of layers for each element. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed region of reference surface. Used as the support for the output fields. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| min_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Min Container. Contains five fields with the values, modes, global_layer_in_stack, local_layer_in_element and solid_element_id | -| **Pin 1**| max_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Max Container. Contains five fields with the values, modes, global_layer_in_stack, local_layer_in_element and solid_element_id | +| **Pin 0**| min_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Min Container. Contains five fields with the values, modes, global_layer_in_stack, local_layer_in_element and solid_element_id | +| **Pin 1**| max_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Max Container. Contains five fields with the values, modes, global_layer_in_stack, local_layer_in_element and solid_element_id | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_over_multiple_failure_criteria_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_over_multiple_failure_criteria_operator.md index 85dd3ccbf4..56fe8a7a50 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_over_multiple_failure_criteria_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_over_multiple_failure_criteria_operator.md @@ -16,19 +16,19 @@ Computes max failure criterion for all the input criterion per ElementalNodal da | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_strain_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_strain_operator.md index dc6ef0d34d..3e13f76d80 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_strain_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_strain_operator.md @@ -16,24 +16,24 @@ Computes max strain for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |`materials_container` | | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification: For instance {"active": true, "e1": true, "e12": true, "e13": false, "e2": true, "e23": false, "e3": false, "eSxy": 0, "eSxz": 0, "eSyz": 0, "eXc": 0, "eXt": 0, "eYc": 0, "eYt": 0, "eZc": 0, "eZt": 0, "force_global_strain_limits": false, "wf_e1": 1, "wf_e12": 1, "wf_e13": 1, "wf_e2": 1, "wf_e23": 1, "wf_e3": 1} | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 400
Required| strains_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | +| Pin 23
Required| materials_container |materials_container | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification: For instance {"active": true, "e1": true, "e12": true, "e13": false, "e2": true, "e23": false, "e3": false, "eSxy": 0, "eSxz": 0, "eSyz": 0, "eXc": 0, "eXt": 0, "eYc": 0, "eYt": 0, "eZc": 0, "eZt": 0, "force_global_strain_limits": false, "wf_e1": 1, "wf_e12": 1, "wf_e13": 1, "wf_e2": 1, "wf_e23": 1, "wf_e3": 1} | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/mechanical_sampling_point_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/mechanical_sampling_point_operator.md index 6ac66cb11f..c10744c371 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/mechanical_sampling_point_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/mechanical_sampling_point_operator.md @@ -16,20 +16,20 @@ Uses json failure configuration to compute evaluate composite sampling point. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 100
Required| result_definition |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Combined sampling point configuration (string of json dict | -| Pin 310| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](./../../core-concepts/dpf-types.md#result-info), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 100
Required| result_definition |[`string`](../../core-concepts/dpf-types.md#standard-types) | Combined sampling point configuration (string of json dict | +| Pin 310| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| results |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Result in the json format. | +| **Pin 0**| results |[`string`](../../core-concepts/dpf-types.md#standard-types) | Result in the json format. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/minmax_per_element_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/minmax_per_element_operator.md index 429bde2f0b..59e74595df 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/minmax_per_element_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/minmax_per_element_operator.md @@ -16,22 +16,22 @@ Computes minmax Elemental data per element | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 21
Required| material_support |`abstract_field_support` | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 21
Required| material_support |abstract_field_support | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_min |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure values under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. The container with the layer indices (1-based) is optional. Use 'layer index - 1' to retriev the layer results from the initial field (e.g. strains or stresses). | -| **Pin 1**| field_max |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure values under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. The container with the layer indices (1-based) is optional. Use 'layer index - 1' to access the layer results from the initial field (e.g. strains or stresses). | +| **Pin 0**| field_min |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure values under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. The container with the layer indices (1-based) is optional. Use 'layer index - 1' to retriev the layer results from the initial field (e.g. strains or stresses). | +| **Pin 1**| field_max |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure values under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. The container with the layer indices (1-based) is optional. Use 'layer index - 1' to access the layer results from the initial field (e.g. strains or stresses). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/multiple_failure_criteria_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/multiple_failure_criteria_operator.md index c13a037d7d..dc478aa80d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/multiple_failure_criteria_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/multiple_failure_criteria_operator.md @@ -16,29 +16,29 @@ Uses failure configuration, CMeshedRegion and stress and strain fields to comput | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The mesh region which is consistent with the strain and stress containers. | -| Pin 23
Required| materials_container |`materials_container` | | -| Pin 24
Required| section_data_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Section data fields container. Only needed for some of the failure criteria evaluations. | -| Pin 25
Required| mesh_properties_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Mesh property fields container. Only needed if eLayupModelContextPin (218) is true. | -| Pin 100
Required| configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Combined failure criterion configuration (string of json dict | -| Pin 102
Required| check_meshed_region |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The check is enabled by default but it can be costly if the meshes are huge. | -| Pin 103
Required| is_acp_composite_model |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Deprecated since 2024 R2. Please use eLayupModelContextPin (pin 218). Set to true for ACP composites models. Default is false. | -| Pin 104
Required| skip_sandwich_criteria |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Skip the sandwich criteria. This should be true if not all plies are selected in which case sandwich criteria cannot be evaluated in a meaningful way. Default is false. | -| Pin 218
Required| layup_model_context_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Define the source of section data. Values are: 0=not available, 1=ACP, 2=RST, 3=MIXED (ACP+RST). Default is not available. | -| Pin 400
Required| strains_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | CFieldsContainer with strains | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | CFieldsContainer with stresses | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The mesh region which is consistent with the strain and stress containers. | +| Pin 23
Required| materials_container |materials_container | | +| Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section data fields container. Only needed for some of the failure criteria evaluations. | +| Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mesh property fields container. Only needed if eLayupModelContextPin (218) is true. | +| Pin 100
Required| configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Combined failure criterion configuration (string of json dict | +| Pin 102
Required| check_meshed_region |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The check is enabled by default but it can be costly if the meshes are huge. | +| Pin 103
Required| is_acp_composite_model |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Deprecated since 2024 R2. Please use eLayupModelContextPin (pin 218). Set to true for ACP composites models. Default is false. | +| Pin 104
Required| skip_sandwich_criteria |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Skip the sandwich criteria. This should be true if not all plies are selected in which case sandwich criteria cannot be evaluated in a meaningful way. Default is false. | +| Pin 218
Required| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Define the source of section data. Values are: 0=not available, 1=ACP, 2=RST, 3=MIXED (ACP+RST). Default is not available. | +| Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | CFieldsContainer with strains | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | CFieldsContainer with stresses | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/nearest_neighbor_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/nearest_neighbor_operator.md index 0862bd6d63..5fac2ea42c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/nearest_neighbor_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/nearest_neighbor_operator.md @@ -16,22 +16,22 @@ Go through all elements of the source mesh and find the n nearest neighbors in t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| source_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed region with the elements for which the nearest neighbors should be found. | -| Pin 1
Required| target_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh with the target elements. | -| Pin 2
Required| number_of_neighbors |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Number of neighbors to be found. | +| Pin 0
Required| source_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed region with the elements for which the nearest neighbors should be found. | +| Pin 1
Required| target_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh with the target elements. | +| Pin 2
Required| number_of_neighbors |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of neighbors to be found. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| neighbors_source_to_target |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | Property field with an entry for each element ID of the source mesh with the element ID(s) of the neighbors of the target mesh. See output neighbors_target_to_source for the inverse result (Pin 1). | -| **Pin 1**| neighbors_target_to_source |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | Property field with an entry for each element ID of the target mesh with the element ID(s) of the neighbors of the source mesh. The field contains only the elements which have neighbors. See output neighbors_source_to_target for the inverse result (Pin 0) | +| **Pin 0**| neighbors_source_to_target |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Property field with an entry for each element ID of the source mesh with the element ID(s) of the neighbors of the target mesh. See output neighbors_target_to_source for the inverse result (Pin 1). | +| **Pin 1**| neighbors_target_to_source |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Property field with an entry for each element ID of the target mesh with the element ID(s) of the neighbors of the source mesh. The field contains only the elements which have neighbors. See output neighbors_source_to_target for the inverse result (Pin 0) | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/puck_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/puck_operator.md index 6d4637daab..0fedee7562 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/puck_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/puck_operator.md @@ -16,25 +16,25 @@ Computes Puck for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"force_global_constants": false, "dim": 2, "p_21_pos": 0.325, "p_21_neg": 0.275, "p_22_neg": 0.225, "p_22_pos": 0.225, "interface_weakening_factor": 0.8, "s": 0.5, "M": 0.5, "pf": false, "pma": false, "pmb": false, "pmc": false, "pd": false, "wf_pf": 1., "wf_pma": 1., "wf_pmb": 1., "wf_pmc": 1., "wf_pd": 1., "cfps": true} | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 400
Required| strains_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"force_global_constants": false, "dim": 2, "p_21_pos": 0.325, "p_21_neg": 0.275, "p_22_neg": 0.225, "p_22_pos": 0.225, "interface_weakening_factor": 0.8, "s": 0.5, "M": 0.5, "pf": false, "pma": false, "pmb": false, "pmc": false, "pd": false, "wf_pf": 1., "wf_pma": 1., "wf_pmb": 1., "wf_pmc": 1., "wf_pd": 1., "cfps": true} | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/reference_surface_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/reference_surface_operator.md index ae2468025e..4733f8e842 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/reference_surface_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/reference_surface_operator.md @@ -16,21 +16,21 @@ Reads the reference surface from solid composite definition file(s) and generate | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | List of composite definitions (h5) files with mapping files. Use the sResultKey to name the parts. | -| Pin 310
Required| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](./../../core-concepts/dpf-types.md#result-info), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types) | Unit system. The output (mesh) will be converted into this unit system. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | List of composite definitions (h5) files with mapping files. Use the sResultKey to name the parts. | +| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Unit system. The output (mesh) will be converted into this unit system. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mapping_field |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | Property field that contains a map from the reference_surface element id to the solid element ids. | -| **Pin 7**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed region containing the reference surface. | +| **Pin 0**| mapping_field |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Property field that contains a map from the reference_surface element id to the solid element ids. | +| **Pin 7**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed region containing the reference surface. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/result_definition.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/result_definition.md index 40986f3c31..d53aa690f6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/result_definition.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/result_definition.md @@ -16,19 +16,19 @@ Uses a simplified json config to create a result definition | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Simplified configuration (string of json dict) Currently limited to a single time step and a single file per type.Supports only irf evaluation. Example: {"files":{"rst_file": "example_path","material_file": "example_path","layup_file": "example_path","mapping_file": "example_path"},"ply_ids": ["example_ply_1", "example_ply_2"],"element_ids": [1,2,3,4],"write_data_for_full_element_scope": false,"failure_configuration": {}} | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Simplified configuration (string of json dict) Currently limited to a single time step and a single file per type.Supports only irf evaluation. Example: {"files":{"rst_file": "example_path","material_file": "example_path","layup_file": "example_path","mapping_file": "example_path"},"ply_ids": ["example_ply_1", "example_ply_2"],"element_ids": [1,2,3,4],"write_data_for_full_element_scope": false,"failure_configuration": {}} | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| string |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Result Definition (string of json dict) that can be used for the composite_failure_operator | +| **Pin 0**| string |[`string`](../../core-concepts/dpf-types.md#standard-types) | Result Definition (string of json dict) that can be used for the composite_failure_operator | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/run_mapdl_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/run_mapdl_operator.md index f2035ca647..bb66ef0676 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/run_mapdl_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/run_mapdl_operator.md @@ -16,22 +16,22 @@ Runs mapdl and returns CFieldsContainer with the results at requested time | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_scoping |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1
Required| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data sources with the input rst file | -| Pin 107
Required| result_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Results to read from rst file. Comma separated string. Supports 'S' and 'EPEL'. Example: 'S,EPEL' | +| Pin 0
Required| time_scoping |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources with the input rst file | +| Pin 107
Required| result_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Results to read from rst file. Comma separated string. Supports 'S' and 'EPEL'. Example: 'S,EPEL' | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 4**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container with the result data | +| **Pin 4**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container with the result data | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_config_reader.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_config_reader.md index f411ae6bc8..1cc004cbf0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_config_reader.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_config_reader.md @@ -16,20 +16,20 @@ Reads scope configuration from inputs and outputs a CompositeScopeConfig object. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 108| ply_ids |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Vector of selected plies. | -| Pin 307| scope_configuration |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | DataTree with scope configuration: These properties are available: requested_times: optional[double]. Default: Last time step/ load step selected. | +| Pin 108| ply_ids |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Vector of selected plies. | +| Pin 307| scope_configuration |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | DataTree with scope configuration: These properties are available: requested_times: optional[double]. Default: Last time step/ load step selected. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scope_configuration |`struct dataProcessing::composite::CompositeScopeConfig` | Scope configuration | +| **Pin 0**| scope_configuration |struct dataProcessing::composite::CompositeScopeConfig | Scope configuration | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_generator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_generator.md index 1da47b0dc7..b6ad7b6c26 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_generator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_generator.md @@ -16,24 +16,24 @@ Generator operator that returns an element chunk each time generator_counteris m | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| generator_counter |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Increment this input to get the next element scope for output element_scoping . | -| Pin 1| element_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Element scoping | -| Pin 3| stream_provider |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | stream_provider of the result file. Required if no explicit element scope is providedor the result definition contains Named Selections. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Composite data sources | -| Pin 402| data_tree |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | Configuration containing the following keys: max_chunk_size (int) and named_selections ([string])) | +| Pin 0
Required| generator_counter |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Increment this input to get the next element scope for output element_scoping . | +| Pin 1| element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Element scoping | +| Pin 3| stream_provider |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | stream_provider of the result file. Required if no explicit element scope is providedor the result definition contains Named Selections. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Composite data sources | +| Pin 402| data_tree |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | Configuration containing the following keys: max_chunk_size (int) and named_selections ([string])) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| element_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Element scoping for current chunk. | -| **Pin 1**| is_finished |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Returns true if generator has returned all the requested elements. In this case the output of pin element_scoping is empty. | +| **Pin 0**| element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Element scoping for current chunk. | +| **Pin 1**| is_finished |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Returns true if generator has returned all the requested elements. In this case the output of pin element_scoping is empty. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/shear_crimping_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/shear_crimping_operator.md index f4526f46f2..741ad8719c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/shear_crimping_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/shear_crimping_operator.md @@ -16,25 +16,25 @@ Computes shear crimping criterion for layered elements. Use the composite::layup | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 24
Required| section_data_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Section Data Container | -| Pin 25
Required| mesh_properties_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to compute Shear Crimping for solids. Not needed to compute wrinkling for shells. | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "kc" : 1., "kf" : 0., "wf" : 1.0}" | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section Data Container | +| Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to compute Shear Crimping for solids. Not needed to compute wrinkling for shells. | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "kc" : 1., "kf" : 0., "wf" : 1.0}" | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md index a98574bb42..c306f25604 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md @@ -16,24 +16,24 @@ Evaluates failure criteria for short fiber composites. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | Time Scoping | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Mesh Scoping | -| Pin 2| stress_limit_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use 'ultimate' or 'yield' strengths. Default is 'ultimate'. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional: RST File stream. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Input files: APDL ds.dat, APDL RST file, Engineering Data MatML file. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Time Scoping | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Mesh Scoping | +| Pin 2| stress_limit_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Whether to use 'ultimate' or 'yield' strengths. Default is 'ultimate'. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional: RST File stream. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Input files: APDL ds.dat, APDL RST file, Engineering Data MatML file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value = 1 and failure modes under the label is_failure_value = 0 from a specific failure criterion operator. | -| **Pin 1**| materials_container |`materials_container` | Materials container enriched with field variables and temperature. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value = 1 and failure modes under the label is_failure_value = 0 from a specific failure criterion operator. | +| **Pin 1**| materials_container |materials_container | Materials container enriched with field variables and temperature. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md index 468939f11b..339ed2ce34 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md @@ -16,22 +16,22 @@ Computes Hill-type Equivalent Stress for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 401
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 401
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | A CField with the equivalent stress. | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | A CField with the equivalent stress. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_lifetime_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_lifetime_operator.md index 6f18026c5a..1f4447e826 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_lifetime_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_lifetime_operator.md @@ -16,23 +16,23 @@ Lifetime evaluation for short fiber composites. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | Time Scoping | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Mesh Scoping | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional: RST File stream. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Input files: APDL ds.dat, APDL RST file, Engineering Data MatML file. | -| Pin 5
Required| rainflow_matrix |[`field`](./../../core-concepts/dpf-types.md#field) | Rainflow matrix | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Time Scoping | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Mesh Scoping | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional: RST File stream. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Input files: APDL ds.dat, APDL RST file, Engineering Data MatML file. | +| Pin 5
Required| rainflow_matrix |[`field`](../../core-concepts/dpf-types.md#field) | Rainflow matrix | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the lifetime under the label is_life=1 and damage under the label is_life=0. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the lifetime under the label is_life=1 and damage under the label is_life=0. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/string_container.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/string_container.md index e76fe929e2..1031dccff7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/string_container.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/string_container.md @@ -16,19 +16,19 @@ Operator which stores a string at each input pin. It supports unlimited number o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| string |[`string`](./../../core-concepts/dpf-types.md#standard-types) | First value. | +| Pin 0| string |[`string`](../../core-concepts/dpf-types.md#standard-types) | First value. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| strings |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | List of input strings | +| **Pin 0**| strings |[`vector`](../../core-concepts/dpf-types.md#standard-types) | List of input strings | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_hill_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_hill_operator.md index d9ecfad88b..7da79da709 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_hill_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_hill_operator.md @@ -16,24 +16,24 @@ Computes Tsai-Hill for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_wu_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_wu_operator.md index 6d9307c03f..3ffe5156fa 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_wu_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_wu_operator.md @@ -16,24 +16,24 @@ Computes Tsai-Wu for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/unit_system_default.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/unit_system_default.md index 7d3782b788..84b5639f53 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/unit_system_default.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/unit_system_default.md @@ -16,20 +16,20 @@ Returns the in the rst stream if specified, otherwise return the default unit sy | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3
Required| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Stream with result file | -| Pin 50
Required| default_unit_system |`class boost::optional` | default_unit_system | +| Pin 3
Required| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Stream with result file | +| Pin 50
Required| default_unit_system |class boost::optional | default_unit_system | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| unit_system |`class dataProcessing::unit::CUnitSystem` | unit_system | +| **Pin 0**| unit_system |class dataProcessing::unit::CUnitSystem | unit_system | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/von_mises_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/von_mises_operator.md index a8f1d86554..a04d35e9ca 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/von_mises_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/von_mises_operator.md @@ -16,25 +16,25 @@ Computes VonMises for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |`materials_container` | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "vme" : true, "vms" : true, "wf_vme" : 1.0, "wf_vms" : 1.0}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | -| Pin 102
Required| check_mesh_regions |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 400
Required| strains_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 401
Required| stresses_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "vme" : true, "vms" : true, "wf_vme" : 1.0, "wf_vms" : 1.0}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value=1 and failure modes under the label is_failure_value=0 from a specific failure criterion operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_svd.md b/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_svd.md index 9804762534..6f9391c90a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_svd.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_svd.md @@ -1,6 +1,6 @@ --- category: compression -plugin: core +plugin: N/A license: any_dpf_supported_increments --- @@ -16,32 +16,32 @@ Computes the coefficients (=U*Sigma) and VT components from SVD. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_contaner_to_compress |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields container to be compressed | -| Pin 1
Required| scalar_int |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | number of vectors (r) to keep for the future reconstraction of the matrix A, ex. A[m,n]=coef[m,r]*VT[r,n], where coef=U*Sigma | -| Pin 2
Required| scalar_double |[`double`](./../../core-concepts/dpf-types.md#standard-types) | threshold (precision) as a double, default value is 1e-7. If both pin1 and pin2 are provided, choose the min r-vectors | -| Pin 3
Required| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | apply svd on the initial data (Default : false), otherwise use reduced data (square matrix with the smallest dimensions). | +| Pin 0
Required| field_contaner_to_compress |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container with data to be compressed | +| Pin 1| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of vectors (r) to keep for the future reconstraction of the matrix A, ex.A[m,n] = coef[m,r] * VT[r,n], where coef = U * Sigma | +| Pin 2| scalar_double |[`double`](../../core-concepts/dpf-types.md#standard-types) | Threshold (precision) as a double (Default : 1e-7). If both pin1 and pin2 are provided, choose the min r-vectors | +| Pin 3| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Apply SVD on the initial data (Default : false), otherwise use reduced data (square matrix with the smallest dimensions). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| us_svd |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | the output entity is a field container (time dependant); it contains the multiplication of two matrices, U and S, where A=U.S.Vt | -| **Pin 1**| vt_svd |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | the output entity is a field container (space dependant), containing the Vt, where A=U.S.Vt | -| **Pin 2**| sigma |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | the output entity is a field (or a field container if input fc contains several labels, where field contains results per label), containing singular (S) values of the input data, where A=U.S.Vt | +| **Pin 0**| us_svd |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The output entity is a fields container (time dependant); it contains the product of two matrices, U and S, where A=U.S.Vt | +| **Pin 1**| vt_svd |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The output entity is a field container (space dependant), containing the Vt, where A=U.S.Vt | +| **Pin 2**| sigma |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The output entity is a field (or a field container if input fc contains several labels, where field contains results per label), containing singular (S) values of the input data, where A=U.S.Vt | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting **Category**: compression - **Plugin**: core + **Plugin**: N/A **Scripting name**: apply_svd diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_zfp.md b/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_zfp.md index e4cd3c9db4..8de0f3349a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_zfp.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_zfp.md @@ -16,30 +16,30 @@ Compressing input data using one of zfp compression algorithm modes. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| dataIn |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container to be compressed | -| Pin 1
Required| mode |[`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') | -| Pin 2
Required| mode_parameter |[`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) | -| Pin 3| dim |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | dimension (1D/2D/3D) for data organization before the compression (int; default: 2) | -| Pin 4| order |[`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) | -| Pin 5| double_absthreshold |[`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). | -| Pin 6| double_relthreshold |[`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). | +| Pin 0
Required| dataIn |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container to be compressed | +| Pin 1
Required| mode |[`string`](../../core-concepts/dpf-types.md#standard-types), [`char`](../../core-concepts/dpf-types.md#char) | zfp mode: fixed-rate ('r'), fixed-precision ('p'), fixed-accuracy ('a') | +| Pin 2
Required| mode_parameter |[`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) | +| Pin 3| dim |[`int32`](../../core-concepts/dpf-types.md#standard-types) | dimension (1D/2D/3D) for data organization before the compression (int; default: 2) | +| Pin 4| order |[`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) | +| Pin 5| double_absthreshold |[`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). | +| Pin 6| double_relthreshold |[`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 | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| compress_speed |[`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] | -| **Pin 1**| compress_ratio |[`double`](./../../core-concepts/dpf-types.md#standard-types) | the output entity is a double, containing compression rate = initial/compressed | -| **Pin 2**| dataOut |[`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. | +| **Pin 0**| compress_speed |[`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] | +| **Pin 1**| compress_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types) | the output entity is a double, containing compression rate = initial/compressed | +| **Pin 2**| dataOut |[`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 | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cuda** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, zfp fixed-rate parallel (de)compression will use CUDA. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cuda** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, zfp fixed-rate parallel (de)compression will use CUDA. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/compression/kmeans_clustering.md b/2026R1/dpf-framework-26-r1/operator-specifications/compression/kmeans_clustering.md index 010f1de12e..44b28631ce 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/compression/kmeans_clustering.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/compression/kmeans_clustering.md @@ -16,22 +16,22 @@ Apply kMeans clustering to group data depending on the data's non-linearity. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| clusters_number |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | number of the clusters (dafault is 3) | -| Pin 1| formula |[`string`](./../../core-concepts/dpf-types.md#standard-types) | formula ('dist'/'dotprod'), default is 'dist' | -| Pin 2
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | an iunput fields container containing the data which will be used for the clustering | -| Pin 3| component_number |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | component number as an int (default is 0), ex '0' for X-displacement, '1' for Y-displacement,... | +| Pin 0| clusters_number |[`int32`](../../core-concepts/dpf-types.md#standard-types) | number of the clusters (dafault is 3) | +| Pin 1| formula |[`string`](../../core-concepts/dpf-types.md#standard-types) | formula ('dist'/'dotprod'), default is 'dist' | +| Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | an iunput fields container containing the data which will be used for the clustering | +| Pin 3| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types) | component number as an int (default is 0), ex '0' for X-displacement, '1' for Y-displacement,... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping_clusters |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Scopings container with the space scoping (entities' ids) corresponding to each of k-clusters | +| **Pin 0**| scoping_clusters |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Scopings container with the space scoping (entities' ids) corresponding to each of k-clusters | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization.md b/2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization.md new file mode 100644 index 0000000000..c2cfe9185a --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization.md @@ -0,0 +1,51 @@ +--- +category: compression +plugin: N/A +license: any_dpf_supported_increments +--- + +# compression:quantization field + +**Version: 0.0.0** + +## Description + +Applies scaling to precision to all the values from field input, then rounding to the unit. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| input_field |[`field`](../../core-concepts/dpf-types.md#field) | Input field | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Threshold (precision) desired. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| output_field |[`field`](../../core-concepts/dpf-types.md#field) | Scaled and rounded field | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: compression + + **Plugin**: N/A + + **Scripting name**: quantization + + **Full name**: compression.quantization + + **Internal name**: quantization + + **License**: any_dpf_supported_increments + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization_fc.md new file mode 100644 index 0000000000..9da546b5fb --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization_fc.md @@ -0,0 +1,51 @@ +--- +category: compression +plugin: N/A +license: any_dpf_supported_increments +--- + +# compression:quantization fields container + +**Version: 0.0.0** + +## Description + +Applies scaling to precision to all the values from fields container input, then rounding to the unit. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| input_fc |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Input fields container | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Threshold (precision) desired. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| output_fc |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Scaled and rounded fields container | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: compression + + **Plugin**: N/A + + **Scripting name**: quantization_fc + + **Full name**: compression.quantization_fc + + **Internal name**: quantization_fc + + **License**: any_dpf_supported_increments + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/compression/zfp_decompress.md b/2026R1/dpf-framework-26-r1/operator-specifications/compression/zfp_decompress.md index 82f5cab0ba..9d022f872c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/compression/zfp_decompress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/compression/zfp_decompress.md @@ -16,20 +16,20 @@ zfp decompression using the information about compression written into the prope | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| dataIn |[`custom_type_fields_container`](./../../core-concepts/dpf-types.md#custom-type-fields-container) | custom type field container from zfp_compression operator to decompress | +| Pin 0
Required| dataIn |[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | custom type field container from zfp_compression operator to decompress | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| dataOut |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | the output entity is a field or a fields container; it contains decompressed data | -| **Pin 1**| decompress_speed |[`double`](./../../core-concepts/dpf-types.md#standard-types) | the output entity is a double, containing decompression speed (mb/sec) | +| **Pin 0**| dataOut |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | the output entity is a field or a fields container; it contains decompressed data | +| **Pin 1**| decompress_speed |[`double`](../../core-concepts/dpf-types.md#standard-types) | the output entity is a double, containing decompression speed (mb/sec) | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/abc_weightings.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/abc_weightings.md index 7af595829a..76457bfcdf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/abc_weightings.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/abc_weightings.md @@ -16,22 +16,22 @@ Computes ABC-weightings for the amplitude spectrum in dB units. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | data to be weighted in dB units. | -| Pin 1
Required| weighting_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | if this pin is set to 0, the A-weighting is computed, 1 the B-weigting is computed and 2 the C-weightings is computed. | -| Pin 2
Required| shape_by_tf_scoping |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, each field of the input fields container is defined by time freq scoping and not by ids. Default is false | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | data to be weighted in dB units. | +| Pin 1
Required| weighting_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to 0, the A-weighting is computed, 1 the B-weigting is computed and 2 the C-weightings is computed. | +| Pin 2
Required| shape_by_tf_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, each field of the input fields container is defined by time freq scoping and not by ids. Default is false | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| weightings |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | weighted data in dB units. | +| **Pin 0**| weightings |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | weighted data in dB units. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_band_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_band_pass.md index 90267dfdee..330fd35499 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_band_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_band_pass.md @@ -16,21 +16,21 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| min_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_band_pass_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_band_pass_fc.md index 6a1db4e53d..f8e1be0538 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_band_pass_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_band_pass_fc.md @@ -16,21 +16,21 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| min_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_high_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_high_pass.md index 96af4a9225..36dbc288ac 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_high_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_high_pass.md @@ -16,21 +16,21 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_high_pass_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_high_pass_fc.md index 24bd369e92..43672a89ab 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_high_pass_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_high_pass_fc.md @@ -16,21 +16,21 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_low_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_low_pass.md index ece8d66f3e..601eb09975 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_low_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_low_pass.md @@ -16,21 +16,21 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_low_pass_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_low_pass_fc.md index 598f59673f..227d497330 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_low_pass_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_low_pass_fc.md @@ -16,21 +16,21 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_signed_high_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_signed_high_pass.md index 68648266b1..9e4e2b5644 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_signed_high_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_signed_high_pass.md @@ -16,21 +16,21 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_signed_high_pass_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_signed_high_pass_fc.md index fbc1a34311..a866e0f32d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_signed_high_pass_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/field_signed_high_pass_fc.md @@ -16,21 +16,21 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/filtering_max_over_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/filtering_max_over_time.md index 36c21be472..04a40a1163 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/filtering_max_over_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/filtering_max_over_time.md @@ -16,22 +16,22 @@ Creates a filtering workflow that will filter results based on a threshold of a | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| invariant_fc_operator |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Name of the invariant operator to be used to calculate filter (available: eqv_fc, invariants_deriv_fc, invariants_fc). | -| Pin 1| output_pin |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Output pin of the invariant operator. Default = 0. | -| Pin 2| list_of_results |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types) | If no result is given, filter will be applied on Stresses and Strains | -| Pin 3| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Threshold from which the operator will filter. | +| Pin 0
Required| invariant_fc_operator |[`string`](../../core-concepts/dpf-types.md#standard-types) | Name of the invariant operator to be used to calculate filter (available: eqv_fc, invariants_deriv_fc, invariants_fc). | +| Pin 1| output_pin |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Output pin of the invariant operator. Default = 0. | +| Pin 2| list_of_results |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | If no result is given, filter will be applied on Stresses and Strains | +| Pin 3| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Threshold from which the operator will filter. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | | +| **Pin 0**| workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_band_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_band_pass.md index 45c504460c..9be64a06a0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_band_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_band_pass.md @@ -16,21 +16,21 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| min_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_high_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_high_pass.md index 3e1f3d594f..77178ff20d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_high_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_high_pass.md @@ -16,21 +16,21 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_low_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_low_pass.md index 52d5303c8c..723ba65803 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_low_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_low_pass.md @@ -16,21 +16,21 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_signed_high_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_signed_high_pass.md index 5c1b288bea..ec59fabbb5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_signed_high_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/scoping_signed_high_pass.md @@ -16,21 +16,21 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_band_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_band_pass.md index 0c1becb061..303c2f0d00 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_band_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_band_pass.md @@ -16,22 +16,22 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| min_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| **Pin 1**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| **Pin 1**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_high_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_high_pass.md index a97fbda3d1..bba724621f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_high_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_high_pass.md @@ -16,22 +16,22 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| **Pin 1**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| **Pin 1**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_low_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_low_pass.md index d7a3fd3112..260311037c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_low_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_low_pass.md @@ -16,22 +16,22 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| **Pin 1**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| **Pin 1**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_signed_high_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_signed_high_pass.md index 3a0ae4ce82..6f59032385 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_signed_high_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timefreq_signed_high_pass.md @@ -16,22 +16,22 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| **Pin 1**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| **Pin 1**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_band_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_band_pass.md index 209229543a..7e80e0ef2b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_band_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_band_pass.md @@ -16,21 +16,21 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| min_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_high_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_high_pass.md index cf8c0daf95..3eb42c983a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_high_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_high_pass.md @@ -16,21 +16,21 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_low_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_low_pass.md index bf49a1d848..26a72910a8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_low_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_low_pass.md @@ -16,21 +16,21 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_signed_high_pass.md b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_signed_high_pass.md index 66e067d9a3..aa28b7c9c9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_signed_high_pass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/filter/timescoping_signed_high_pass.md @@ -16,21 +16,21 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/cartesian_to_spherical.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/cartesian_to_spherical.md index 7c2378d168..ceb5e1cbc3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/cartesian_to_spherical.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/cartesian_to_spherical.md @@ -16,21 +16,21 @@ Converts 3D field from cartesian coordinates to spherical coordinates. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/cartesian_to_spherical_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/cartesian_to_spherical_fc.md index 7c6c617ef6..77eabd852f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/cartesian_to_spherical_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/cartesian_to_spherical_fc.md @@ -16,21 +16,21 @@ Converts 3D field from cartesian coordinates to spherical coordinates. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/element_nodal_contribution.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/element_nodal_contribution.md index 9bf7bd3044..7d322be954 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/element_nodal_contribution.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/element_nodal_contribution.md @@ -16,21 +16,21 @@ Compute the fraction of the element measure attributed to each node of each elem | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Integrate the input field over a specific scoping. | -| Pin 2| volume_fraction |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, returns influence volume, area or length. If false, the values are normalized with the element volume, area or length. Default: true. | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Integrate the input field over a specific scoping. | +| Pin 2| volume_fraction |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, returns influence volume, area or length. If false, the values are normalized with the element volume, area or length. Default: true. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_facets_surfaces_over_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_facets_surfaces_over_time.md index ad6859ffa7..9ef615a07a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_facets_surfaces_over_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_facets_surfaces_over_time.md @@ -16,22 +16,22 @@ Calculates for a mesh, the surface of each element's facet over time for each sp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Displacement field's container. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh must be defined if the displacement field's container does not contain it, or if there is no displacement. | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 2| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Displacement field's container. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh must be defined if the displacement field's container does not contain it, or if there is no displacement. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Surfaces field. | -| **Pin 1**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh made of surface elements only. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Surfaces field. | +| **Pin 1**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh made of surface elements only. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_volume.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_volume.md index c495ae61f5..0aad719a68 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_volume.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_volume.md @@ -16,22 +16,22 @@ Compute the measure of the Elements (volume for 3D elements, surface for 2D elem | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | If not provided, the measure of all elements for the mesh is computed. If provided, the Scoping needs to have "Elemental" location. | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | If not provided, the measure of all elements for the mesh is computed. If provided, the Scoping needs to have "Elemental" location. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_volumes_over_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_volumes_over_time.md index 9f54a16147..48c8397df6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_volumes_over_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/elements_volumes_over_time.md @@ -16,21 +16,21 @@ Calculates for a mesh, the volume of each element over time for each specified t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Displacement field's container. Must contain the mesh if mesh not specified in input. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh must be defined if the displacement field's container does not contain it, or if there is no displacement. | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 2| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Displacement field's container. Must contain the mesh if mesh not specified in input. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh must be defined if the displacement field's container does not contain it, or if there is no displacement. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/faces_area.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/faces_area.md index 9117b57cbe..a845bbdab2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/faces_area.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/faces_area.md @@ -16,20 +16,20 @@ Compute the measure of the Faces (surface for 2D faces of a 3D model or length f | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | If not provided, the measure of all Faces in the mesh is computed. If provided, the Scoping needs to have "Faces" location. | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | If not provided, the measure of all Faces in the mesh is computed. If provided, the Scoping needs to have "Faces" location. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/gauss_to_node.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/gauss_to_node.md index 8e5833c538..c9d4afef1e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/gauss_to_node.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/gauss_to_node.md @@ -16,21 +16,21 @@ Extrapolating results available at Gauss or quadrature points to nodal points fo | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Scoping to integrate on, if not provided, the one from input field is provided. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh to integrate on. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping to integrate on, if not provided, the one from input field is provided. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh to integrate on. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/integrate_over_elements.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/integrate_over_elements.md index b891fffc48..47b68eec00 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/integrate_over_elements.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/integrate_over_elements.md @@ -16,23 +16,23 @@ Integration of an input field over mesh. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Integrate the input field over a specific scoping. | -| Pin 2| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh to integrate on. If not provided, the one from input field is employed. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Integrate the input field over a specific scoping. | +| Pin 2| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh to integrate on. If not provided, the one from input field is employed. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/normals.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/normals.md index 44b1f43929..8bb4d23497 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/normals.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/normals.md @@ -1,7 +1,7 @@ --- category: geo plugin: core -license: any_dpf_supported_increments +license: None --- # geo:scoping normals @@ -16,21 +16,21 @@ compute the normals at the given nodes or element scoping based on the given mes | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 3| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 3| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting @@ -44,7 +44,7 @@ compute the normals at the given nodes or element scoping based on the given mes **Internal name**: normals_provider - **License**: any_dpf_supported_increments + **License**: None ## Changelog diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/normals_provider_nl.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/normals_provider_nl.md index cd85c9cd72..5429cf0ef8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/normals_provider_nl.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/normals_provider_nl.md @@ -1,7 +1,7 @@ --- category: geo plugin: core -license: any_dpf_supported_increments +license: None --- # geo:normals provider nl (nodes, faces, or elements) @@ -16,21 +16,21 @@ Computes the normals on nodes/faces/elements based on integration points (more a | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Skin, face, or shell mesh region. | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Elemental, ElementalNodal, or Nodal scoping. Location derived from this. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | If no scoping, specifies location. If scoping is Elemental or ElementalNodal this overrides scoping. Default is Elemental. | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Skin, face, or shell mesh region. | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental, ElementalNodal, or Nodal scoping. Location derived from this. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | If no scoping, specifies location. If scoping is Elemental or ElementalNodal this overrides scoping. Default is Elemental. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting @@ -44,7 +44,7 @@ Computes the normals on nodes/faces/elements based on integration points (more a **Internal name**: normals_provider_nl - **License**: any_dpf_supported_increments + **License**: None ## Changelog diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate.md index c1d729c485..39cb0f94be 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate.md @@ -16,22 +16,22 @@ Applies a transformation (rotation) matrix on a field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| field_rotation_matrix |[`field`](./../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| field_rotation_matrix |[`field`](../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_fc.md index 3a6ec91ab9..4fb58b98d4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_fc.md @@ -16,22 +16,22 @@ Apply a transformation (rotation) matrix on all the fields of a fields container | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| coordinate_system |[`field`](./../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| coordinate_system |[`field`](../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_in_cylindrical_cs.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_in_cylindrical_cs.md index 2cc23adc03..70e472d49f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_in_cylindrical_cs.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_in_cylindrical_cs.md @@ -16,23 +16,23 @@ Rotates a field to its corresponding values into the specified cylindrical coord | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| coordinate_system |[`field`](./../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix and origin coordinates must be set here to define a coordinate system. | -| Pin 2| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh support of the input field. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| coordinate_system |[`field`](../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix and origin coordinates must be set here to define a coordinate system. | +| Pin 2| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh support of the input field. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md index a18eed341f..fbd87cf607 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md @@ -16,23 +16,23 @@ Rotates all the fields of a fields container (not defined with a cynlindrical co | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| coordinate_system |[`field`](./../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix and origin coordinates must be set here to define a coordinate system. | -| Pin 2| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh support of the input fields_container, in case it does not have one defined. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| coordinate_system |[`field`](../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix and origin coordinates must be set here to define a coordinate system. | +| Pin 2| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh support of the input fields_container, in case it does not have one defined. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/spherical_to_cartesian.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/spherical_to_cartesian.md index c941029e2a..f282ce40fb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/spherical_to_cartesian.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/spherical_to_cartesian.md @@ -16,21 +16,21 @@ Converts 3D field from spherical coordinates to cartesian coordinates. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/spherical_to_cartesian_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/spherical_to_cartesian_fc.md index b7a03f91f1..ee4bee4b28 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/spherical_to_cartesian_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/spherical_to_cartesian_fc.md @@ -16,21 +16,21 @@ Converts 3D field from spherical coordinates to cartesian coordinates. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/geo/to_polar_coordinates.md b/2026R1/dpf-framework-26-r1/operator-specifications/geo/to_polar_coordinates.md index bdbc809618..21a0308129 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/geo/to_polar_coordinates.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/geo/to_polar_coordinates.md @@ -16,22 +16,22 @@ Finds r, theta (rad), and z coordinates of a coordinates (nodal) field in a cart | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| coordinate_system |[`field`](./../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix and origin coordinates must be set here to define a coordinate system. By default, the rotation axis is the z axis and the origin is [0,0,0]. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| coordinate_system |[`field`](../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix and origin coordinates must be set here to define a coordinate system. By default, the rotation axis is the z axis and the origin is [0,0,0]. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_bcs_to_nod.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_bcs_to_nod.md index 5e2d874ec7..4c786a8ee1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_bcs_to_nod.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_bcs_to_nod.md @@ -16,20 +16,20 @@ Converts a fields container from BCS to NOD ordering. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 2
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain the full file). | +| Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain the full file). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_nod_to_bcs.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_nod_to_bcs.md index b9b5a26e92..28c6b7e52f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_nod_to_bcs.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_nod_to_bcs.md @@ -16,20 +16,20 @@ Converts a fields container from NOD to BCS ordering. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 2
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain the full file). | +| Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain the full file). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_op.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_op.md index 5bbf87a4d0..4bc89b9816 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_op.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/convertnum_op.md @@ -16,22 +16,22 @@ Converts a fields container from one mapdl ordering to another mapdl ordering. S | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_ordering |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Input ordering number | -| Pin 1
Required| output_ordering |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Output ordering number | -| Pin 2
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Expect fields container | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain the full file). | +| Pin 0
Required| input_ordering |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Input ordering number | +| Pin 1
Required| output_ordering |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Output ordering number | +| Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Expect fields container | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain the full file). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_values.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_values.md index 555b1aaa90..4142276853 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_values.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_values.md @@ -16,21 +16,21 @@ Computes the element-wise Eigen values of a tensor field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_values_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_values_fc.md index ab037dac98..ab065583b1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_values_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_values_fc.md @@ -16,21 +16,21 @@ Computes the element-wise Eigen values of all the tensor fields of a fields cont | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_vectors.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_vectors.md index c1b3e86d84..8242626e6c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_vectors.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_vectors.md @@ -16,19 +16,19 @@ Computes the element-wise Eigen vectors for each tensor in the field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_vectors_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_vectors_fc.md index 3b7d2de67b..cb0dafe3cf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_vectors_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/eigen_vectors_fc.md @@ -16,21 +16,21 @@ Computes the element-wise Eigen vectors for each tensor in the fields of the fie | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/invariants.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/invariants.md index fb57800e1e..1631a80c59 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/invariants.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/invariants.md @@ -16,23 +16,23 @@ Computes the element-wise invariants of a tensor field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_int |[`field`](./../../core-concepts/dpf-types.md#field) | stress intensity field | -| **Pin 1**| field_eqv |[`field`](./../../core-concepts/dpf-types.md#field) | stress equivalent intensity | -| **Pin 2**| field_max_shear |[`field`](./../../core-concepts/dpf-types.md#field) | max shear stress field | +| **Pin 0**| field_int |[`field`](../../core-concepts/dpf-types.md#field) | stress intensity field | +| **Pin 1**| field_eqv |[`field`](../../core-concepts/dpf-types.md#field) | stress equivalent intensity | +| **Pin 2**| field_max_shear |[`field`](../../core-concepts/dpf-types.md#field) | max shear stress field | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/invariants_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/invariants_fc.md index 58e89c03b1..1069ad173c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/invariants_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/invariants_fc.md @@ -16,23 +16,23 @@ Computes the element-wise invariants of all the tensor fields of a fields contai | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_int |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | stress intensity field | -| **Pin 1**| fields_eqv |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | stress equivalent intensity | -| **Pin 2**| fields_max_shear |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | max shear stress field | +| **Pin 0**| fields_int |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | stress intensity field | +| **Pin 1**| fields_eqv |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | stress equivalent intensity | +| **Pin 2**| fields_max_shear |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | max shear stress field | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/principal_invariants.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/principal_invariants.md index d44320227f..4ca9d61e6c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/principal_invariants.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/principal_invariants.md @@ -16,23 +16,23 @@ Computes the element-wise Eigen values of a tensor field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_eig_1 |[`field`](./../../core-concepts/dpf-types.md#field) | first eigen value field | -| **Pin 1**| field_eig_2 |[`field`](./../../core-concepts/dpf-types.md#field) | second eigen value field | -| **Pin 2**| field_eig_3 |[`field`](./../../core-concepts/dpf-types.md#field) | third eigen value field | +| **Pin 0**| field_eig_1 |[`field`](../../core-concepts/dpf-types.md#field) | first eigen value field | +| **Pin 1**| field_eig_2 |[`field`](../../core-concepts/dpf-types.md#field) | second eigen value field | +| **Pin 2**| field_eig_3 |[`field`](../../core-concepts/dpf-types.md#field) | third eigen value field | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/principal_invariants_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/principal_invariants_fc.md index fcb7bf5c50..821d97029e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/principal_invariants_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/principal_invariants_fc.md @@ -16,23 +16,23 @@ Computes the element-wise Eigen values of all the tensor fields of a fields cont | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_eig_1 |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | first eigen value fields | -| **Pin 1**| fields_eig_2 |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | second eigen value fields | -| **Pin 2**| fields_eig_3 |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | third eigen value fields | +| **Pin 0**| fields_eig_1 |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | first eigen value fields | +| **Pin 1**| fields_eig_2 |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | second eigen value fields | +| **Pin 2**| fields_eig_3 |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | third eigen value fields | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/segalman_von_mises_eqv.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/segalman_von_mises_eqv.md index 08df97c3ae..6b2918bb48 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/segalman_von_mises_eqv.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/segalman_von_mises_eqv.md @@ -16,21 +16,21 @@ Computes the element-wise Segalman Von-Mises criteria on a tensor field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/segalman_von_mises_eqv_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/segalman_von_mises_eqv_fc.md index a3cb57777d..0564edc293 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/segalman_von_mises_eqv_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/segalman_von_mises_eqv_fc.md @@ -16,21 +16,21 @@ Computes the element-wise Segalman Von-Mises criteria on all the tensor fields o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/von_mises_eqv.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/von_mises_eqv.md index 6ab78d82af..299a196f6a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/von_mises_eqv.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/von_mises_eqv.md @@ -16,22 +16,22 @@ Computes the element-wise Von-Mises criteria on a tensor field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 13
Required| poisson_ratio |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | Poisson ratio to be used in equivalent strain calculation. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 13
Required| poisson_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Poisson ratio to be used in equivalent strain calculation. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/von_mises_eqv_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/von_mises_eqv_fc.md index 33734d8dc3..6832ed94c1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/invariant/von_mises_eqv_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/invariant/von_mises_eqv_fc.md @@ -16,22 +16,22 @@ Computes the element-wise Von-Mises criteria on all the tensor fields of a field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 13
Required| poisson_ratio |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | Poisson ratio to be used in equivalent strain calculation. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 13
Required| poisson_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Poisson ratio to be used in equivalent strain calculation. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/ascending_sort.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/ascending_sort.md index dbaad223de..440d20124d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/ascending_sort.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/ascending_sort.md @@ -16,21 +16,21 @@ Sort a field (in 0) in ascending order with an optional component priority table | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| component_priority_table |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | -| Pin 2| sort_by_scoping |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | +| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/ascending_sort_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/ascending_sort_fc.md index c1499d3cd5..b9eaa2ba0d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/ascending_sort_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/ascending_sort_fc.md @@ -16,21 +16,21 @@ Sort a field (in 0) in ascending order with an optional component priority table | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| component_priority_table |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | -| Pin 2| sort_by_scoping |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | +| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_selector.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_selector.md index d4499c449e..17887c1232 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_selector.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_selector.md @@ -16,21 +16,21 @@ Creates a scalar/vector field based on the selected component. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| component_number |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | One or several component index that will be extracted from the initial field. | -| Pin 2| default_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Set a default value for components that do not exist. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | One or several component index that will be extracted from the initial field. | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Set a default value for components that do not exist. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_selector_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_selector_fc.md index a9a5ac77bb..f1b6124741 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_selector_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_selector_fc.md @@ -16,20 +16,20 @@ Creates a scalar fields container based on the selected component for each field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| component_number |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | one or several component index that will be extracted from the initial field. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | one or several component index that will be extracted from the initial field. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_transformer.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_transformer.md index d272b5f81e..bec5aefc41 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_transformer.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_transformer.md @@ -16,21 +16,21 @@ Takes the input field and creates a field with overriden value on given componen | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| component_number |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | One or several component index that will be modified from the initial field. | -| Pin 2| default_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Set a default value for components selected. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | One or several component index that will be modified from the initial field. | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Set a default value for components selected. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_transformer_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_transformer_fc.md index 5fd36e2707..545811eafd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_transformer_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/component_transformer_fc.md @@ -16,21 +16,21 @@ Takes the input field and creates a field with overriden value on given componen | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| component_number |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | One or several component index that will be modified from the initial field. | -| Pin 2| default_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Set a default value for components selected. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | One or several component index that will be modified from the initial field. | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Set a default value for components selected. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/descending_sort.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/descending_sort.md index 80b24d9c3c..e45251bdc4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/descending_sort.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/descending_sort.md @@ -16,21 +16,21 @@ Sort a field (in 0) in descending order, with an optional component priority tab | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| component_priority_table |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | -| Pin 2| sort_by_scoping |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | +| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/descending_sort_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/descending_sort_fc.md index 03968166ab..fe1d6778e7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/descending_sort_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/descending_sort_fc.md @@ -16,21 +16,21 @@ Sort a field (in 0) in descending order, with an optional component priority tab | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| component_priority_table |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | -| Pin 2| sort_by_scoping |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | +| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/elementary_data_selector.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/elementary_data_selector.md index 297f4b1ea7..2fe801d748 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/elementary_data_selector.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/elementary_data_selector.md @@ -16,22 +16,22 @@ Creates a scalar/vector field based on the selected elementary data. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| elementary_data_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | One or several elementary data index that will be extracted from the initial field. For field with nature matrix, this is the line indices to extract. | -| Pin 2| default_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Set a default value for elementary data that do not exist. | -| Pin 3| elementary_data_index_2 |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | For field with nature matrix, this is the column indices to extract. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| elementary_data_index |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | One or several elementary data index that will be extracted from the initial field. For field with nature matrix, this is the line indices to extract. | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Set a default value for elementary data that do not exist. | +| Pin 3| elementary_data_index_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | For field with nature matrix, this is the column indices to extract. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/elementary_data_selector_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/elementary_data_selector_fc.md index c8be85def5..90c87751f5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/elementary_data_selector_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/elementary_data_selector_fc.md @@ -16,21 +16,21 @@ Creates a scalar fields container based on the selected elementary data for each | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| elementary_data_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | one or several elementary data indices that will be extracted from the initial field. For a field with a nature matrix, this extracts the line indices. | -| Pin 3| elementary_data_index_2 |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | For a field with nature matrix, this extracts the column indices. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| elementary_data_index |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | one or several elementary data indices that will be extracted from the initial field. For a field with a nature matrix, this extracts the line indices. | +| Pin 3| elementary_data_index_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | For a field with nature matrix, this extracts the column indices. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/enrich_materials.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/enrich_materials.md index 2b3fa6493c..3b09a78a0d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/enrich_materials.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/enrich_materials.md @@ -17,20 +17,20 @@ Takes a MaterialContainer and a stream and enriches the MaterialContainer using | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| MaterialContainer | | | -| Pin 1
Required| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2
Required| streams_mapping |[`property_fields_container`](./../../core-concepts/dpf-types.md#property-fields-container) | | +| Pin 1
Required| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 2
Required| streams_mapping |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| MaterialContainer |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| MaterialContainer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_anys.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_anys.md index d24d0d798d..5656099dc1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_anys.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_anys.md @@ -16,24 +16,24 @@ Takes two Any objects and compares them.Supported types: Field, FieldsContainer, | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| anyA |[`any`](./../../core-concepts/dpf-types.md#any) | | -| Pin 1
Required| anyB |[`any`](./../../core-concepts/dpf-types.md#any) | | -| Pin 2
Required| double_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | -| Pin 3| double_tolerance |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | -| Pin 4
Required| compare_auxiliary |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | +| Pin 0
Required| anyA |[`any`](../../core-concepts/dpf-types.md#any) | | +| Pin 1
Required| anyB |[`any`](../../core-concepts/dpf-types.md#any) | | +| Pin 2
Required| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | +| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | +| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| included |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | bool (true if belongs...) | -| **Pin 1**| message |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| included |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if belongs...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_fc.md index 61f91f2d11..4d5b08750c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_fc.md @@ -16,23 +16,23 @@ Checks if two fields_container are identical. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_containerA |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| fields_containerB |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2| small_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value which will be considered during the comparison step. All the abs(values) in the field less than this value are considered as null, (default value:1.0e-14). | -| Pin 3| tolerance |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). | +| Pin 0
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 2| small_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value which will be considered during the comparison step. All the abs(values) in the field less than this value are considered as null, (default value:1.0e-14). | +| Pin 3| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | -| **Pin 1**| message |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_fields.md index 4d007a2579..8b2fabd01b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_fields.md @@ -16,23 +16,23 @@ Check if two fields are identical. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 2| double_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | -| Pin 3| double_tolerance |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < relativeTol. Default is 0.001. | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 2| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | +| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < relativeTol. Default is 0.001. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | -| **Pin 1**| message |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_generic_data_containers.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_generic_data_containers.md index e7da6d8155..b6af0f4dbd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_generic_data_containers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_generic_data_containers.md @@ -16,24 +16,24 @@ Takes two generic data containers and compares them. Supported types: Field, Fie | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| generic_data_containerA |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | | -| Pin 1
Required| generic_data_containerB |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | | -| Pin 2
Required| double_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | -| Pin 3| double_tolerance |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | -| Pin 4
Required| compare_auxiliary |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | +| Pin 0
Required| generic_data_containerA |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | | +| Pin 1
Required| generic_data_containerB |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | | +| Pin 2
Required| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | +| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | +| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| included |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | bool (true if belongs...) | -| **Pin 1**| message |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| included |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if belongs...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_mc.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_mc.md index 5f1c686b53..313df8b5f5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_mc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_mc.md @@ -16,24 +16,24 @@ Checks if two meshes_container are identical. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| meshes_containerA |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 1
Required| meshes_containerB |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 2| small_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value which will be considered during the comparison step. All the abs(values) in the field less than this value are considered as null, (default value:1.0e-14). | -| Pin 3| tolerance |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). | -| Pin 4
Required| compare_auxiliary |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | +| Pin 0
Required| meshes_containerA |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 1
Required| meshes_containerB |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 2| small_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value which will be considered during the comparison step. All the abs(values) in the field less than this value are considered as null, (default value:1.0e-14). | +| Pin 3| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). | +| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types) | compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | -| **Pin 1**| message |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_meshes.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_meshes.md index 807700f688..38bab04b89 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_meshes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_meshes.md @@ -16,23 +16,23 @@ Takes two meshes and compares them. Note: When comparing mesh properties, the cu | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| meshA |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| meshB |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 2| small_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | define what is a small value for numeric comparison (default value:1.0e-14). | -| Pin 3| tolerance |[`double`](./../../core-concepts/dpf-types.md#standard-types) | define the relative tolerance ceil for numeric comparison (default is 0.001). | -| Pin 4
Required| compare_auxiliary |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | +| Pin 0
Required| meshA |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| meshB |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 2| small_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | define what is a small value for numeric comparison (default value:1.0e-14). | +| Pin 3| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | define the relative tolerance ceil for numeric comparison (default is 0.001). | +| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types) | compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| are_identical |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| are_identical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_pfc.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_pfc.md index 5d1a5937dc..134138303d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_pfc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_pfc.md @@ -16,21 +16,21 @@ Checks if two property_fields_container are identical. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| property_fields_containerA |[`property_fields_container`](./../../core-concepts/dpf-types.md#property-fields-container) | | -| Pin 1
Required| property_fields_containerB |[`property_fields_container`](./../../core-concepts/dpf-types.md#property-fields-container) | | +| Pin 0
Required| property_fields_containerA |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | | +| Pin 1
Required| property_fields_containerB |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | -| **Pin 1**| message |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_property_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_property_fields.md index df7d2a9b16..dbeba135c8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_property_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_property_fields.md @@ -16,21 +16,21 @@ Takes two property fields and compares them. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| property_fieldA |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| property_fieldB |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| property_fieldA |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| property_fieldB |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| are_identical |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 1**| information |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| are_identical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 1**| information |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_sc.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_sc.md index 1c73a1afef..8cc79b9eee 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_sc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_sc.md @@ -16,21 +16,21 @@ Checks if two scopings_container are identical. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| scopings_containerA |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | | -| Pin 1
Required| scopings_containerB |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | | +| Pin 0
Required| scopings_containerA |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | +| Pin 1
Required| scopings_containerB |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | -| **Pin 1**| message |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_scopings.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_scopings.md index 0bf1a3be22..32d099155d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_scopings.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_scopings.md @@ -16,21 +16,21 @@ Check if two scopings are identical. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| scopingA |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1
Required| scopingB |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| Pin 0
Required| scopingA |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1
Required| scopingB |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | -| **Pin 1**| message |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_string_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_string_fields.md index 1f0cd9031a..99e79e6d2f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_string_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/identical_string_fields.md @@ -16,21 +16,21 @@ Takes two string fields and compares them. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| string_fieldA |[`string_field`](./../../core-concepts/dpf-types.md#string-field) | | -| Pin 1
Required| string_fieldB |[`string_field`](./../../core-concepts/dpf-types.md#string-field) | | +| Pin 0
Required| string_fieldA |[`string_field`](../../core-concepts/dpf-types.md#string-field) | | +| Pin 1
Required| string_fieldB |[`string_field`](../../core-concepts/dpf-types.md#string-field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| are_identical |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 1**| information |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| are_identical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 1**| information |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/included_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/included_fields.md index c4c0f2fc67..7f8e2a92dc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/included_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/included_fields.md @@ -16,23 +16,23 @@ Checks if one field belongs to another. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 2
Required| double_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | -| Pin 3| double_tolerance |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 2
Required| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | +| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| included |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | bool (true if belongs...) | -| **Pin 1**| message |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| included |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if belongs...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/solid_shell_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/solid_shell_fields.md new file mode 100644 index 0000000000..70e6350ef3 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/solid_shell_fields.md @@ -0,0 +1,50 @@ +--- +category: logic +plugin: core +license: None +--- + +# logic:merge solid and shell fields + +**Version: 0.0.0** + +## Description + +Merges shell and solid fields for each time step/frequency in the fields container. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: logic + + **Plugin**: core + + **Scripting name**: solid_shell_fields + + **Full name**: logic.solid_shell_fields + + **Internal name**: merge::solid_shell_fields + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/split_data_sources.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/split_data_sources.md index 681b254cb9..19e8ad2f5e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/split_data_sources.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/split_data_sources.md @@ -16,21 +16,21 @@ Splits a Data Sources into multiple coherent data sources, actual number of outp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data sources to split. | -| Pin 1
Required| output_count |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Number of desired outputs. | +| Pin 0
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources to split. | +| Pin 1
Required| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of desired outputs. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin -1**| output_count |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Actual number of outputs. | -| **Pin 0**| outputs |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data sources outputs. | +| **Pin -1**| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Actual number of outputs. | +| **Pin 0**| outputs |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources outputs. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/logic/split_streams.md b/2026R1/dpf-framework-26-r1/operator-specifications/logic/split_streams.md index 18ba72379f..5d3cbfebe1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/logic/split_streams.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/logic/split_streams.md @@ -16,21 +16,21 @@ Splits a Streams into multiple coherent streams, actual number of outputs is alw | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Streams to split. | -| Pin 1
Required| output_count |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Number of desired outputs. | +| Pin 0
Required| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams to split. | +| Pin 1
Required| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of desired outputs. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin -1**| output_count |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Actual number of outputs. | -| **Pin 0**| outputs |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Streams outputs. | +| **Pin -1**| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Actual number of outputs. | +| **Pin 0**| outputs |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams outputs. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/fft.md b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/fft.md index a0a1e4c150..9ad20c9177 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/fft.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/fft.md @@ -16,24 +16,24 @@ Computes the Fast Fourier Transform on each component of input Field or each fie | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Field or Fields Container. | -| Pin 3| scale_forward_transform |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Scale for Forward Transform, default is 2/field_num_elementary_data. | -| Pin 4| inplace |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | True if inplace, default is false. | -| Pin 5| force_fft_points |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Explicitely define number of fft points to either rescope or perform zero padding. | -| Pin 6| cutoff_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Restrict output frequency up to this cutoff frequency | -| Pin 7| scale_right_amplitude |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If set to true (default is false), 2/field_num_entities scaling will be applied, to have right amplitude values. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field or Fields Container. | +| Pin 3| scale_forward_transform |[`double`](../../core-concepts/dpf-types.md#standard-types) | Scale for Forward Transform, default is 2/field_num_elementary_data. | +| Pin 4| inplace |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True if inplace, default is false. | +| Pin 5| force_fft_points |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Explicitely define number of fft points to either rescope or perform zero padding. | +| Pin 6| cutoff_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | Restrict output frequency up to this cutoff frequency | +| Pin 7| scale_right_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true (default is false), 2/field_num_entities scaling will be applied, to have right amplitude values. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Output Complex Fields Container with labels matching input Fields Container. No supports binded, but prepare_sampling_fft provides it. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Output Complex Fields Container with labels matching input Fields Container. No supports binded, but prepare_sampling_fft provides it. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/find_reduced_coordinates.md b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/find_reduced_coordinates.md index feffaf7c85..fc61d551f0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/find_reduced_coordinates.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/find_reduced_coordinates.md @@ -16,22 +16,22 @@ Finds the elements corresponding to the given coordinates in input and computes | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1
Required| coordinates |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | If the first field in input has no mesh in support, then the mesh in this pin is expected (default is false). If a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container. | -| Pin 200| use_quadratic_elements |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, reduced coordinates are computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. | +| Pin 1
Required| coordinates |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | If the first field in input has no mesh in support, then the mesh in this pin is expected (default is false). If a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container. | +| Pin 200| use_quadratic_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, reduced coordinates are computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| reduced_coordinates |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | coordinates in the reference elements | -| **Pin 1**| element_ids |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Ids of the elements where each set of reduced coordinates is found | +| **Pin 0**| reduced_coordinates |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | coordinates in the reference elements | +| **Pin 1**| element_ids |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Ids of the elements where each set of reduced coordinates is found | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/on_coordinates.md b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/on_coordinates.md index c02d010c1a..025ca6b52c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/on_coordinates.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/on_coordinates.md @@ -16,24 +16,25 @@ Evaluates a result on specified coordinates (interpolates results inside element | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| coordinates |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 2| create_support |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, then, a support associated to the fields consisting of points is created | -| Pin 3| mapping_on_scoping |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, then the mapping between the coordinates and the fields is created only on the first field scoping | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | if the first field in input has no mesh in support, then the mesh in this pin is expected (default is false), if a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container | -| Pin 200| use_quadratic_elements |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, the element search for each coordinate is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| coordinates |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 2| create_support |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, then, a support associated to the fields consisting of points is created | +| Pin 3| mapping_on_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, then the mapping between the coordinates and the fields is created only on the first field scoping | +| Pin 5| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tolerance used in the iterative algorithm to locate coordinates inside the mesh. Default value: 5e-5. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | if the first field in input has no mesh in support, then the mesh in this pin is expected (default is false), if a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container | +| Pin 200| use_quadratic_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, the element search for each coordinate is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/on_reduced_coordinates.md b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/on_reduced_coordinates.md index 4964e11713..d7a4575513 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/on_reduced_coordinates.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/on_reduced_coordinates.md @@ -16,23 +16,23 @@ Evaluates a result on specified reduced coordinates of given elements (interpola | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| reduced_coordinates |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | coordinates in the reference elements to find (found with the operator "find_reduced_coordinates") | -| Pin 2
Required| element_ids |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Ids of the elements where each set of reduced coordinates is found (found with the operator "find_reduced_coordinates") | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | if the first field in input has no mesh in support, then the mesh in this pin is expected (default is false), if a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container | -| Pin 200| use_quadratic_elements |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, the interpolation is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. To use only when results have mid side nodes values. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| reduced_coordinates |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | coordinates in the reference elements to find (found with the operator "find_reduced_coordinates") | +| Pin 2
Required| element_ids |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Ids of the elements where each set of reduced coordinates is found (found with the operator "find_reduced_coordinates") | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | if the first field in input has no mesh in support, then the mesh in this pin is expected (default is false), if a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container | +| Pin 200| use_quadratic_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, the interpolation is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. To use only when results have mid side nodes values. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/prep_sampling_fft.md b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/prep_sampling_fft.md index 9a29336e84..0ff8f82572 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/prep_sampling_fft.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/prep_sampling_fft.md @@ -16,22 +16,22 @@ Prepare time sampling optimum for FFT computation and expected frequencies in ou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | Initial time domain TimeFreqSupport. | -| Pin 1| cutoff_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Cutoff Frequency. In this case, number of points is calculated computing (time_range * cutoff_freq * 2) and taking the next power of 2 (optimum for fft calculation). | -| Pin 2| number_sampling_point |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | For number of sampling point (calculation with cutoff_frequency is ignored). | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | Initial time domain TimeFreqSupport. | +| Pin 1| cutoff_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | Cutoff Frequency. In this case, number of points is calculated computing (time_range * cutoff_freq * 2) and taking the next power of 2 (optimum for fft calculation). | +| Pin 2| number_sampling_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | For number of sampling point (calculation with cutoff_frequency is ignored). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| time_tfs_sampled |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | Optimum sampled time domain TimeFreqSupport. | -| **Pin 1**| freq_tfs_fft |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | Frequency domain TimeFreqSupport expected in output of FFT. | +| **Pin 0**| time_tfs_sampled |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | Optimum sampled time domain TimeFreqSupport. | +| **Pin 1**| freq_tfs_fft |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | Frequency domain TimeFreqSupport expected in output of FFT. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/prepare_mapping_workflow.md b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/prepare_mapping_workflow.md index 1356657ba7..76e02276dd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/prepare_mapping_workflow.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/prepare_mapping_workflow.md @@ -16,22 +16,22 @@ Generates a workflow that can map results from a support to another one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_support |[`field`](./../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| output_support |[`field`](./../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 2
Required| filter_radius |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Radius size for the RBF filter | -| Pin 3| influence_box |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| input_support |[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| output_support |[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 2
Required| filter_radius |[`double`](../../core-concepts/dpf-types.md#standard-types) | Radius size for the RBF filter | +| Pin 3| influence_box |[`double`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mapping_workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | | +| **Pin 0**| mapping_workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/scoping_on_coordinates.md b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/scoping_on_coordinates.md index ec8d690c96..b196ed58aa 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/scoping_on_coordinates.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/scoping_on_coordinates.md @@ -16,20 +16,20 @@ Finds the Elemental scoping of a set of coordinates. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| coordinates |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| coordinates |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/solid_to_skin.md b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/solid_to_skin.md index d04ec32a9c..805f18fd39 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/solid_to_skin.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/solid_to_skin.md @@ -16,21 +16,23 @@ Maps a field defined on solid elements to a field defined on skin elements. Thre | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | skin mesh region expected | -| Pin 2| solid_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Solid mesh support (optional). | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | skin mesh region expected | +| Pin 2| solid_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Solid mesh support (optional). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/solid_to_skin_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/solid_to_skin_fc.md index ad5544ef98..17bce89e02 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mapping/solid_to_skin_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mapping/solid_to_skin_fc.md @@ -4,33 +4,35 @@ plugin: core license: None --- -# mapping:solid to skin (fields container) +# mapping:solid to skin fc **Version: 0.0.0** ## Description -Maps a field defined on solid elements to a field defined on skin elements. Three cases are possible, based on the solid field data location; (i) Elemental: The values associated with the solid elements are copied according to those underlying the skin, (ii) Nodal: The solid field is rescoped with respect to the nodes of the skin mesh, (iii) ElementalNodal: The values are copied from the solid mesh to the skin mesh for each element face and the nodes associated with it. +Maps a fields container defined on solid elements to a fields container defined on skin elements. Three cases are possible, based on the solid field data location; (i) Elemental: The values associated with the solid elements are copied according to those underlying the skin, (ii) Nodal: The solid field is rescoped with respect to the nodes of the skin mesh, (iii) ElementalNodal: The values are copied from the solid mesh to the skin mesh for each element face and the nodes associated with it. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | skin mesh region expected | -| Pin 2| solid_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Solid mesh support (optional). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | skin mesh region expected | +| Pin 2| solid_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Solid mesh support (optional). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/absolute_value_by_component.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/absolute_value_by_component.md index 809b2f685a..fea36e7325 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/absolute_value_by_component.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/absolute_value_by_component.md @@ -16,19 +16,19 @@ Compute the absolute value of each data value of the input field, no norm perfor | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/absolute_value_by_component_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/absolute_value_by_component_fc.md index 784a72159b..dd1a9a94a7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/absolute_value_by_component_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/absolute_value_by_component_fc.md @@ -16,19 +16,19 @@ Compute the absolute value of each data value of the input field, no norm perfor | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate.md index ea4b78f676..d8bc8de744 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate.md @@ -16,21 +16,21 @@ Sums all the elementary data of a field to produce one elementary data point. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| weights |[`field`](./../../core-concepts/dpf-types.md#field) | Field containing weights, one weight per entity | -| Pin 2| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | time_scoping | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| weights |[`field`](../../core-concepts/dpf-types.md#field) | Field containing weights, one weight per entity | +| Pin 2| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | time_scoping | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | Field containing the (weighted) sum for each component in an elementary data | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | Field containing the (weighted) sum for each component in an elementary data | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_fc.md index 86f323dc77..43ff015716 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_fc.md @@ -16,21 +16,21 @@ Sums all the elementary data of a field to produce one elementary data point. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| weights |[`field`](./../../core-concepts/dpf-types.md#field) | Field containing weights, one weight per entity | -| Pin 2| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | time_scoping | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| weights |[`field`](../../core-concepts/dpf-types.md#field) | Field containing weights, one weight per entity | +| Pin 2| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | time_scoping | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Field containing the (weighted) sum for each component in an elementary data | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field containing the (weighted) sum for each component in an elementary data | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_level_over_label_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_level_over_label_fc.md index 7f12fbe520..a126812b06 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_level_over_label_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_level_over_label_fc.md @@ -16,21 +16,21 @@ Compute the component-wise sum over all the fields that have the same ID as the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| label |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_min_over_label_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_min_over_label_fc.md index 674c569db6..8159f2204b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_min_over_label_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_min_over_label_fc.md @@ -16,21 +16,21 @@ Compute the component-wise sum over all the fields that have the same ID as the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| label |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_over_label_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_over_label_fc.md index e7f82ce857..8331e89d27 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_over_label_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulate_over_label_fc.md @@ -16,21 +16,21 @@ Compute the component-wise sum over all the fields that have the same ID as the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| label |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulation_per_scoping.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulation_per_scoping.md index adfe583118..6b20e3d368 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulation_per_scoping.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/accumulation_per_scoping.md @@ -16,23 +16,24 @@ This operator calculates the sum and the percentage of total sum of the input fi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Master scoping. All scopings in the Scopings Container will be intersected with this scoping. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5
Required| scopings_container |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | The intersection between the of the first will be used. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Master scoping. All scopings in the Scopings Container will be intersected with this scoping. | +| Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 5
Required| scopings_container |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | The intersection between the of the first will be used. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| accumulation_per_scoping |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| accumulation_per_scoping_percentage |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| accumulation_per_scoping |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| accumulation_per_scoping_percentage |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/add.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/add.md index 5849c20051..28cf70f067 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/add.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/add.md @@ -16,27 +16,27 @@ Computes the sum of two fields. If one field's scoping has 'overall' location, t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/add_constant.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/add_constant.md index 4c89b475c9..5bcd7dceb3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/add_constant.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/add_constant.md @@ -16,20 +16,20 @@ Computes the sum of a field (in 0) and a scalar (in 1). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| weights |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | double or vector of double | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | double or vector of double | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/add_constant_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/add_constant_fc.md index 0196831abc..bef73ecead 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/add_constant_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/add_constant_fc.md @@ -16,20 +16,20 @@ Computes the sum of a field (in 0) and a scalar (in 1). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| weights |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | double or vector of double | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | double or vector of double | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/add_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/add_fc.md index fd7c31c672..f83a64c159 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/add_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/add_fc.md @@ -16,25 +16,25 @@ Selects all fields with the same label space in the input fields container and a | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/amplitude.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/amplitude.md index 2426df0a09..354e2509ce 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/amplitude.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/amplitude.md @@ -16,20 +16,20 @@ Computes amplitude of a real and an imaginary field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/amplitude_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/amplitude_fc.md index 4e266a4c99..20c296d918 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/amplitude_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/amplitude_fc.md @@ -16,19 +16,19 @@ Computes the amplitude of a real and an imaginary field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/average_over_label_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/average_over_label_fc.md index e69fef6038..7c2d14a11a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/average_over_label_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/average_over_label_fc.md @@ -16,21 +16,21 @@ Compute the component-wise average over all the fields that have the same ID as | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| label |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/centroid.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/centroid.md index 5e84e0f323..8ddc4d4553 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/centroid.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/centroid.md @@ -16,24 +16,24 @@ Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2 | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 2
Required| factor |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Scalar | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 2
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | Scalar | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/centroid_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/centroid_fc.md index 6d3c340b7f..f47f1553ab 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/centroid_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/centroid_fc.md @@ -16,23 +16,23 @@ Computes the centroid of all the matching fields of a fields container at a give | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| time_freq |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2| step |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 8| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| time_freq |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| step |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 8| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide.md index e2d96ae8c9..ffdfcafe55 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide.md @@ -16,27 +16,27 @@ Computes component-wise fraction between two fields of same dimensionality. If o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide_fc.md index 934bc9ede3..9bf5a52e8e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide_fc.md @@ -16,26 +16,26 @@ For every two fields with the same label space (from the two input fields contai | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_containerA |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| fields_containerB |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product.md index e176daeb25..f3dea4acc8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product.md @@ -16,27 +16,27 @@ Computes component-wise product between two fields of same dimensionality. If on | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product_fc.md index ad4b7b7426..41cb8dfbc5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product_fc.md @@ -16,27 +16,27 @@ Computes component-wise product between two fields of same dimensionality. If on | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/compute_residual_and_error.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/compute_residual_and_error.md index c5ccc86fdb..921946eb5d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/compute_residual_and_error.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/compute_residual_and_error.md @@ -20,27 +20,27 @@ Computes the Lp-norm of a field or a field container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container1 |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container - compulsory | -| Pin 1| normalization_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | type of normalization applied to the residuals and norm calculation (optional, defaut: absolute):
0 for absolute,
1 for relative to the first entry at a given time step,
2 for normalized by the max at a given time step of the first entry or residuals depending on the reference field option,
3 for normalized by the max over all time steps of the first entry or residuals depending on the reference field option | -| Pin 2| norm_calculation_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | type for norm calculation (optional, default: L2) - It is normalized depending on Pin2 selection
1 for L1, ie sum(abs(xi)),
2 for L2, ie sqrt(sum((xi^2)) | -| Pin 3| field_reference |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Field reference for the normalization step, default: 0 for entry 1, 1 for residuals - optional | -| Pin 4| field_or_fields_container2 |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container of same dimensionality as entry 1 - optional | +| Pin 0
Required| field_or_fields_container1 |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container - compulsory | +| Pin 1| normalization_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | type of normalization applied to the residuals and norm calculation (optional, defaut: absolute):
0 for absolute,
1 for relative to the first entry,
2 for normalized by the max of each field of the first entry or residuals depending on the reference field option,
3 for normalized by the max over all fields of the first entry or residuals depending on the reference field option | +| Pin 2| norm_calculation_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | type for norm calculation (optional, default: L2) - It is normalized depending on Pin2 selection
1 for L1, ie sum(abs(xi)),
2 for L2, ie sqrt(sum((xi^2)) | +| Pin 3| field_reference |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Field reference for the normalization step, default: 0 for entry 1, 1 for residuals - optional | +| Pin 4| field_or_fields_container2 |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container of same dimensionality as entry 1 - optional | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| residuals |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | 0: normalized residuals (aka field 1 - field 2) as a field or field container, normalized depending on the normalization type | -| **Pin 1**| error |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | 1: error as a field or a field container depending on the entry's type. | -| **Pin 2**| residuals_normalization_factor |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | 2: factor used for residual normalization | -| **Pin 3**| error_normalization_factor |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | 3: factor used for error norm normalization | +| **Pin 0**| residuals |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | 0: normalized residuals (aka field 1 - field 2) as a field or field container, normalized depending on the normalization type | +| **Pin 1**| error |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | 1: error as a field or a field container depending on the entry's type. | +| **Pin 2**| residuals_normalization_factor |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | 2: factor used for residual normalization | +| **Pin 3**| error_normalization_factor |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | 3: factor used for error norm normalization | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/conjugate.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/conjugate.md index 7111e875f4..874dc79171 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/conjugate.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/conjugate.md @@ -16,19 +16,19 @@ Computes element-wise conjugate of field containers containing complex fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/correlation.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/correlation.md index e722d5e6d4..6d95cfc424 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/correlation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/correlation.md @@ -16,23 +16,23 @@ Takes two fields and a weighting and computes their correlation: aMb/(||aMa||.|| | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | Field a. The reference field. | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Field b. If a fields container is provided, correlation is computed for each field. | -| Pin 2
Required| weights |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Field M, optional weighting for correlation computation. | -| Pin 3
Required| absoluteValue |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, correlation factor is ||aMb||/(||aMa||.||bMb||) | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Field a. The reference field. | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field b. If a fields container is provided, correlation is computed for each field. | +| Pin 2
Required| weights |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field M, optional weighting for correlation computation. | +| Pin 3
Required| absoluteValue |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, correlation factor is ||aMb||/(||aMa||.||bMb||) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | Correlation factor for each input field b. | -| **Pin 1**| index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If several b are provided, this output contains the index of the highest correlation factor. | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | Correlation factor for each input field b. | +| **Pin 1**| index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If several b are provided, this output contains the index of the highest correlation factor. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cos.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cos.md index 2908ba7cca..d1567d45da 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cos.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cos.md @@ -16,19 +16,19 @@ Computes element-wise cos(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cos_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cos_fc.md index bfb412c923..9c86983b1c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cos_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cos_fc.md @@ -16,19 +16,19 @@ Computes element-wise cos(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_derive.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_derive.md index 35b36ac31a..43c192aad6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_derive.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_derive.md @@ -16,22 +16,22 @@ Derives field containers containing complex fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_divide.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_divide.md index ba5844d317..32901badd7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_divide.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_divide.md @@ -16,20 +16,20 @@ Computes division between two field containers containing complex fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_containerA |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| fields_containerB |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_dot.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_dot.md index 7d31e319be..5eb2dc84d8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_dot.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_dot.md @@ -16,26 +16,26 @@ Computes product between two field containers containing complex fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_containerA |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| fields_containerB |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_multiply.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_multiply.md index 5cb2bbc3c2..eb5ee864fb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_multiply.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_multiply.md @@ -16,26 +16,26 @@ Computes multiplication between two field containers containing complex fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_containerA |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| fields_containerB |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product.md index c54b7cbfb3..0c063e09bc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product.md @@ -16,26 +16,26 @@ Computes the cross product of two vector fields. Fields can have the same locati | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product_fc.md index 8f463ca72d..de543ef777 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product_fc.md @@ -16,26 +16,26 @@ Computes the cross product of two vector fields. Fields can have the same locati | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container_A |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 1
Required| field_or_fields_container_B |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/dot.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/dot.md index c04f1521d7..0d9b90ceb4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/dot.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/dot.md @@ -16,27 +16,27 @@ DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element - wise dot pr | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/dot_tensor.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/dot_tensor.md index cb10584b68..7ae0c05e66 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/dot_tensor.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/dot_tensor.md @@ -16,26 +16,26 @@ DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot prod | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/entity_extractor.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/entity_extractor.md index 406fe61b9e..74310354f7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/entity_extractor.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/entity_extractor.md @@ -16,20 +16,20 @@ Extracts an entity from a field, based on its ID. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| scalar_int |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/expansion_psd.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/expansion_psd.md index b878755b3c..681afda80d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/expansion_psd.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/expansion_psd.md @@ -16,25 +16,25 @@ Computes the PSD response for one-sigma solution. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mode_shapes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container containing the mode shapes from modal analysis file: mode shapes for dynamic and pseudo-static displacements | -| Pin 1| static_shapes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container containing the static shapes (base excitations) from spectral analysis file | -| Pin 2
Required| rel_rel_covar_matrix |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container containing covariance matrices from a psd file: covariance matrix terms for displacement/velocity/acceleration mode-mode shapes | -| Pin 3| stat_stat_covar_matrix |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container containing covariance matrices from a psd file: covariance matrix terms for displacement/velocity/acceleration static-static shapes | -| Pin 4| rel_stat_covar_matrix |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container containing covariance matrices from a psd file: covariance matrix terms for displacement/velocity/acceleration mode-static shapes | +| Pin 0
Required| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container containing the mode shapes from modal analysis file: mode shapes for dynamic and pseudo-static displacements | +| Pin 1| static_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container containing the static shapes (base excitations) from spectral analysis file | +| Pin 2
Required| rel_rel_covar_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container containing covariance matrices from a psd file: covariance matrix terms for displacement/velocity/acceleration mode-mode shapes | +| Pin 3| stat_stat_covar_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container containing covariance matrices from a psd file: covariance matrix terms for displacement/velocity/acceleration static-static shapes | +| Pin 4| rel_stat_covar_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container containing covariance matrices from a psd file: covariance matrix terms for displacement/velocity/acceleration mode-static shapes | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| psd |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | PSD solution per label | +| **Pin 0**| psd |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | PSD solution per label | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/exponential.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/exponential.md index c0bc80756c..8638cb77ba 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/exponential.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/exponential.md @@ -16,19 +16,19 @@ Computes element-wise exp(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/exponential_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/exponential_fc.md index 963aec32cd..6906c10816 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/exponential_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/exponential_fc.md @@ -16,19 +16,19 @@ Computes element-wise exp(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_approx.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_approx.md index 86ec760eb2..3c5c6f55d5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_approx.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_approx.md @@ -17,30 +17,30 @@ Computes the fitting curve using FFT filtering and cubic fitting in space (node | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | A time scoping to rescope / split the fields container given as input. | -| Pin 1| mesh_scoping |`umap`, [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | A space (mesh entities) scoping (or scopings container) to rescope / split the fields container given as input. | -| Pin 2
Required| entity_to_fit |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Data changing in time to be fitted. | -| Pin 3
Required| component_number |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Component number as an integer, for example '0' for X-displacement, '1' for Y-displacement, and so on. | -| Pin 4
Required| first_derivative |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Calculate the first derivative (bool). The default is false. | -| Pin 5
Required| second_derivative |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Calculate the second derivative (bool). The default is false. | -| Pin 6
Required| fit_data |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Calculate the fitted values (bool). The default is false | -| Pin 7| cutoff_fr |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | Cutoff frequency. | +| Pin 0| time_scoping |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | A time scoping to rescope / split the fields container given as input. | +| Pin 1| mesh_scoping |umap, [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | A space (mesh entities) scoping (or scopings container) to rescope / split the fields container given as input. | +| Pin 2
Required| entity_to_fit |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Data changing in time to be fitted. | +| Pin 3
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Component number as an integer, for example '0' for X-displacement, '1' for Y-displacement, and so on. | +| Pin 4
Required| first_derivative |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the first derivative (bool). The default is false. | +| Pin 5
Required| second_derivative |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the second derivative (bool). The default is false. | +| Pin 6
Required| fit_data |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the fitted values (bool). The default is false | +| Pin 7| cutoff_fr |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Cutoff frequency. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fitted_entity_y |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The fitted entity is fitted using FFT along the space scoping (node i: x=time, y=data). Fitted Y is expected to be close to the input data. | -| **Pin 1**| first_der_dy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The first derivative (dY) from the fitted Y. | -| **Pin 2**| second_der_d2y |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The second derivative (d2Y) from the fitted Y. | +| **Pin 0**| fitted_entity_y |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The fitted entity is fitted using FFT along the space scoping (node i: x=time, y=data). Fitted Y is expected to be close to the input data. | +| **Pin 1**| first_der_dy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The first derivative (dY) from the fitted Y. | +| **Pin 2**| second_der_d2y |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The second derivative (d2Y) from the fitted Y. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_eval.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_eval.md index 01a1328c28..1f64aefc6e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_eval.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_eval.md @@ -16,21 +16,21 @@ Evaluate the fast fourier transforms at a given set of fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_t |[`field`](./../../core-concepts/dpf-types.md#field) | field of values to evaluate | -| Pin 1| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | if specified only the results at these set ids are used | +| Pin 0
Required| field_t |[`field`](../../core-concepts/dpf-types.md#field) | field of values to evaluate | +| Pin 1| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | if specified only the results at these set ids are used | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 2**| offset |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 2**| offset |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_gradient_eval.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_gradient_eval.md index 94d8acd91f..ac97b26d26 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_gradient_eval.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_gradient_eval.md @@ -16,21 +16,21 @@ Evaluate min max based on the fast fourier transform at a given field, using gra | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | if specified only the results at these set ids are used | -| Pin 2| fs_ratio |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | default value = 20 | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | if specified only the results at these set ids are used | +| Pin 2| fs_ratio |[`int32`](../../core-concepts/dpf-types.md#standard-types) | default value = 20 | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| coefficients |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| coefficients |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_multi_harmonic_minmax.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_multi_harmonic_minmax.md index 0451824b3a..fb23624ed4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_multi_harmonic_minmax.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_multi_harmonic_minmax.md @@ -16,29 +16,29 @@ Evaluate min max fields on multi harmonic solution. min and max fields are calcu | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| rpm_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | rpm scoping, by default the fourier series sum is evaluated using all the rpms | -| Pin 2| fs_ratio |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 3| num_subdivisions |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | connect number subdivisions, used for uniform discretization | -| Pin 4| max_num_subdivisions |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | connect max number subdivisions, used to avoid huge number of sudivisions | -| Pin 5| num_cycles |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Number of cycle of the periodic signal (default is 2) | -| Pin 6| use_harmonic_zero |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | use harmonic zero for first rpm (default is false) | -| Pin 7| calculate_time_series |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | calculates time series output (output pin 2), setting it to false enhance performance if only min/max are required (default is true) | -| Pin 8| substeps_selector |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | substeps to evaluate (frequencies), by default the operator is evaluated using all the available steps | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| rpm_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | rpm scoping, by default the fourier series sum is evaluated using all the rpms | +| Pin 2| fs_ratio |[`int32`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 3| num_subdivisions |[`int32`](../../core-concepts/dpf-types.md#standard-types) | connect number subdivisions, used for uniform discretization | +| Pin 4| max_num_subdivisions |[`int32`](../../core-concepts/dpf-types.md#standard-types) | connect max number subdivisions, used to avoid huge number of sudivisions | +| Pin 5| num_cycles |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of cycle of the periodic signal (default is 2) | +| Pin 6| use_harmonic_zero |[`bool`](../../core-concepts/dpf-types.md#standard-types) | use harmonic zero for first rpm (default is false) | +| Pin 7| calculate_time_series |[`bool`](../../core-concepts/dpf-types.md#standard-types) | calculates time series output (output pin 2), setting it to false enhance performance if only min/max are required (default is true) | +| Pin 8| substeps_selector |[`vector`](../../core-concepts/dpf-types.md#standard-types) | substeps to evaluate (frequencies), by default the operator is evaluated using all the available steps | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_min |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| field_max |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 2**| all_fields |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field_min |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| field_max |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 2**| all_fields |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product.md index f6f3c9febc..4205dd5859 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product.md @@ -16,26 +16,26 @@ Computes a general notion of inner product between two fields of possibly differ | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product_fc.md index 61bde08ed6..c439bab966 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product_fc.md @@ -16,26 +16,26 @@ Computes a general notion of inner product between two fields of possibly differ | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container_A |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 1
Required| field_or_fields_container_B |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/hdf5_topo_elemental_density.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/hdf5_topo_elemental_density.md index 81a2f072c6..8e83084142 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/hdf5_topo_elemental_density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/hdf5_topo_elemental_density.md @@ -16,23 +16,23 @@ Extract Elemental Topology Density result from topo solver output. Default behav | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | topo file stream. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | topo file data source. | -| Pin 200
Required| custom_ponderation_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | take custom ponderation_field from the topo file by name | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | topo file stream. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | topo file data source. | +| Pin 200
Required| custom_ponderation_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | take custom ponderation_field from the topo file by name | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/hdf5_topo_nodal_density.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/hdf5_topo_nodal_density.md index a9d8b893bf..9c692e0692 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/hdf5_topo_nodal_density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/hdf5_topo_nodal_density.md @@ -16,23 +16,23 @@ Extract Nodal Topology Density result from topo solver output. Default behavior | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | topo file stream. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | topo file data source. | -| Pin 200
Required| custom_ponderation_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | take custom ponderation_field from the topo file by name | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | topo file stream. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | topo file data source. | +| Pin 200
Required| custom_ponderation_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | take custom ponderation_field from the topo file by name | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/img_part.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/img_part.md index 1701c04040..f67a0e74fe 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/img_part.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/img_part.md @@ -16,19 +16,19 @@ Extracts element-wise imaginary part of field containers containing complex fiel | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/invert.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/invert.md index 27ba0619da..82eb52bf33 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/invert.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/invert.md @@ -16,19 +16,19 @@ DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inve | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/invert_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/invert_fc.md index 0d7eb3ff9b..13c6d8863f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/invert_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/invert_fc.md @@ -16,19 +16,19 @@ DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inve | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/kronecker_prod.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/kronecker_prod.md index d60753f01a..70771700c4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/kronecker_prod.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/kronecker_prod.md @@ -16,22 +16,22 @@ Computes element-wise Kronecker product between two tensor fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/linear_combination.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/linear_combination.md index def119cd99..1019820cbd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/linear_combination.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/linear_combination.md @@ -16,23 +16,23 @@ Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| a |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double | -| Pin 1
Required| fields_containerA |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2
Required| fields_containerB |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3
Required| b |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Double | -| Pin 4
Required| fields_containerC |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| a |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double | +| Pin 1
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 2
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3
Required| b |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double | +| Pin 4
Required| fields_containerC |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/ln.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/ln.md index 291d96f481..8e1a3e7d64 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/ln.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/ln.md @@ -16,19 +16,19 @@ Computes element-wise ln(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/ln_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/ln_fc.md index 6ed16e5e9f..fe26c2821e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/ln_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/ln_fc.md @@ -16,19 +16,19 @@ Computes element-wise ln(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/mac.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/mac.md index ee93a85c63..8014e246a2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/mac.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/mac.md @@ -16,21 +16,21 @@ Computes MAC Matrix between two fields container, both for real and complex case | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_containerA |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container A. | -| Pin 1
Required| fields_containerB |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container B. | -| Pin 2
Required| weights |[`field`](./../../core-concepts/dpf-types.md#field) | Field M, optional weighting for MAC Matrix computation. | +| Pin 0
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container A. | +| Pin 1
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container B. | +| Pin 2
Required| weights |[`field`](../../core-concepts/dpf-types.md#field) | Field M, optional weighting for MAC Matrix computation. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | MAC Matrix for all the combinations between mode fields of Field Container A and Field Container B. Results listed row by row. | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | MAC Matrix for all the combinations between mode fields of Field Container A and Field Container B. Results listed row by row. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/make_one_on_comp.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/make_one_on_comp.md index 173e704ffb..25679f33f0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/make_one_on_comp.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/make_one_on_comp.md @@ -16,20 +16,20 @@ Takes the input field's scoping and creates a field full of zeros, except for th | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| scalar_int |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/matrix_inverse.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/matrix_inverse.md index 6c4fba7848..d2bdb75d5b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/matrix_inverse.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/matrix_inverse.md @@ -16,19 +16,19 @@ Computes the complex matrix inverse for each field in the given fields container | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/mechanical_min_max_over_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/mechanical_min_max_over_time.md index ae28c7d090..25873ad1d6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/mechanical_min_max_over_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/mechanical_min_max_over_time.md @@ -16,21 +16,21 @@ Evaluates minimum/maximum over time/frequency. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 5
Required| int32 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Define min or max. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 5
Required| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Define min or max. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_container_1 |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| field_container_2 |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field_container_1 |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| field_container_2 |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/minus.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/minus.md index 8b896e2628..f98af0d30e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/minus.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/minus.md @@ -16,27 +16,27 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/minus_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/minus_fc.md index 5c71de8292..459c7bb234 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/minus_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/minus_fc.md @@ -16,27 +16,27 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container_A |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 1
Required| field_or_fields_container_B |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_damping_ratio.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_damping_ratio.md index b1b4d833fc..b44e8ea814 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_damping_ratio.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_damping_ratio.md @@ -16,23 +16,23 @@ Computes damping ratio for each mode shape as X_i = const + ratio_i + m_coeffici | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| natural_freq |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | input vector expects natural frequencies. | -| Pin 1| const_ratio |[`double`](./../../core-concepts/dpf-types.md#standard-types) | constant modal damping ratio | -| Pin 2| ratio_by_modes |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | modal damping ratio for each mode shape | -| Pin 3
Required| m_coefficient |[`double`](./../../core-concepts/dpf-types.md#standard-types) | global mass matrix multiplier | -| Pin 4
Required| k_coefficient |[`double`](./../../core-concepts/dpf-types.md#standard-types) | global stiffness matrix multiplier | +| Pin 0
Required| natural_freq |[`vector`](../../core-concepts/dpf-types.md#standard-types) | input vector expects natural frequencies. | +| Pin 1| const_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types) | constant modal damping ratio | +| Pin 2| ratio_by_modes |[`vector`](../../core-concepts/dpf-types.md#standard-types) | modal damping ratio for each mode shape | +| Pin 3
Required| m_coefficient |[`double`](../../core-concepts/dpf-types.md#standard-types) | global mass matrix multiplier | +| Pin 4
Required| k_coefficient |[`double`](../../core-concepts/dpf-types.md#standard-types) | global stiffness matrix multiplier | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | field of modal damping ratio. | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | field of modal damping ratio. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_participation.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_participation.md index 8608c24666..72b1814f42 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_participation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_participation.md @@ -16,23 +16,23 @@ Compute the modal participation factor for a given vector field V, defined as s | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| v_real |[`field`](./../../core-concepts/dpf-types.md#field) | real part of field V | -| Pin 1
Required| v_imag |[`field`](./../../core-concepts/dpf-types.md#field) | imag part of field V | -| Pin 2
Required| mode_shapes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| ponderation |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 4| force_label_space |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | If set, will force a label space for output result. | +| Pin 0
Required| v_real |[`field`](../../core-concepts/dpf-types.md#field) | real part of field V | +| Pin 1
Required| v_imag |[`field`](../../core-concepts/dpf-types.md#field) | imag part of field V | +| Pin 2
Required| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| ponderation |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 4| force_label_space |[`label_space`](../../core-concepts/dpf-types.md#label-space) | If set, will force a label space for output result. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| output |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_superposition.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_superposition.md index 45d7a9f183..1879925685 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_superposition.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/modal_superposition.md @@ -10,31 +10,32 @@ license: any_dpf_supported_increments ## Description -Computes the solution in the time/frequency space from a modal solution by multiplying a modal basis (in 0) by the solution in this modal space (coefficients for each mode for each time/frequency) (in 1). +Computes the solution in the time/frequency space from a modal solution by multiplying a modal basis (in 0)by the solution in this modal space (coefficients for each mode for each time/frequency) (in 1). ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| modal_basis |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | One field by mode with each field representing a mode shape on nodes or elements. | -| Pin 1
Required| solution_in_modal_space |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | One field by time/frequency with each field having a ponderating coefficient for each mode of the modal_basis pin. | -| Pin 3| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | Compute the result on a subset of the time frequency domain defined in the solution_in_modal_space fields container. | -| Pin 4| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Compute the result on a subset of the space domain defined in the modal_basis fields container. | +| Pin 0
Required| modal_basis |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | One field by mode with each field representing a mode shape on nodes or elements. | +| Pin 1
Required| solution_in_modal_space |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | One field by time/frequency with each field having a ponderating coefficient for each mode of the modal_basis pin. | +| Pin 2| incremental_fc |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | If a non-empty fields container is introduced, it is modified, and sent to the output, to add the contribution of the requested expansion. The label spaces produced from the multiplication must be the same as the incremental ones. | +| Pin 3| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Compute the result on a subset of the time frequency domain defined in the solution_in_modal_space fields container. | +| Pin 4| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Compute the result on a subset of the space domain defined in the modal_basis fields container. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/modulus.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/modulus.md index a5190d3faf..d7fab74d8f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/modulus.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/modulus.md @@ -16,19 +16,19 @@ Computes element-wise modulus of field containers containing complex fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/norm.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/norm.md index db30493adc..3af1eee060 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/norm.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/norm.md @@ -16,20 +16,20 @@ Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| scalar_int |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/norm_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/norm_fc.md index d91d5fed8f..5381162e54 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/norm_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/norm_fc.md @@ -16,22 +16,22 @@ Computes the element-wise L2 norm of the field elementary data. This process is | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| scalar_int |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Lp normalisation type, p = 1, 2, ...n - Default Lp=2 | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Lp normalisation type, p = 1, 2, ...n - Default Lp=2 | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/outer_product.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/outer_product.md index 67a648d699..efdadf5392 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/outer_product.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/outer_product.md @@ -16,26 +16,26 @@ Computes the outer product of two vector fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/overall_dot.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/overall_dot.md index a4fca3df12..b49cb057a7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/overall_dot.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/overall_dot.md @@ -16,20 +16,20 @@ Computes a dot product between two fields (fields are seen like a single large v | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | Field defined on over-all location, contains a unique scalar value | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | Field defined on over-all location, contains a unique scalar value | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/phase.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/phase.md index 045e7d16d6..1b1eb066f5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/phase.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/phase.md @@ -16,20 +16,20 @@ Computes the phase (in rad) between a real and an imaginary field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/phase_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/phase_fc.md index 6ef9312381..0be2d4074b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/phase_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/phase_fc.md @@ -16,19 +16,19 @@ Computes phase (in rad) between real and imaginary fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/polar_to_cplx.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/polar_to_cplx.md index 377443371e..544df6810d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/polar_to_cplx.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/polar_to_cplx.md @@ -16,19 +16,19 @@ Converts a complex number from polar form to complex. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/pow.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/pow.md index be52248542..174352c535 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/pow.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/pow.md @@ -16,20 +16,20 @@ Computes element-wise field[i]^p. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| factor |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/pow_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/pow_fc.md index a4c6902eb5..22b16c327a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/pow_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/pow_fc.md @@ -16,20 +16,20 @@ Computes element-wise field[i]^p. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| factor |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/qr_solve.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/qr_solve.md index 1b93c8fd5a..a210c76e8c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/qr_solve.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/qr_solve.md @@ -16,20 +16,20 @@ Computes the solution using QR factorization. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | -| Pin 1
Required| rhs |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | +| Pin 1
Required| rhs |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/real_part.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/real_part.md index 98dabf4ce8..928ce0a654 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/real_part.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/real_part.md @@ -16,19 +16,19 @@ Extracts element-wise real part of field containers containing complex fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/relative_error.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/relative_error.md index bb0597df5d..e3f4bcea9b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/relative_error.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/relative_error.md @@ -16,28 +16,28 @@ Computes the relative error between a reference scalar field and another scalar | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| value |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | -| Pin 1
Required| reference |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 0
Required| value |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| reference |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 1**| zero_ref_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Ids of entities where reference value is zero. | -| **Pin 2**| no_ref_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Ids of entities where there are no reference value. | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 1**| zero_ref_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Ids of entities where reference value is zero. | +| **Pin 2**| no_ref_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Ids of entities where there are no reference value. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale.md index 9839792ac3..9f9866d6fc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale.md @@ -16,23 +16,23 @@ Scales a field by a constant factor. This factor can be a scalar or a vector, wh | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| weights |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | Double/Field/Vector of doubles. When scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping | -| Pin 2| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Default is false. If set to true, output of scale is made dimensionless | -| Pin 3| algorithm |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Default is 0 use mkl. If set to 1, don't | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Double/Field/Vector of doubles. When scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping | +| Pin 2| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If set to true, output of scale is made dimensionless | +| Pin 3| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Default is 0 use mkl. If set to 1, don't | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field.md index b47487717d..cc95269c56 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field.md @@ -16,26 +16,26 @@ DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field_fc.md index a9fc7512d6..ec9671cae1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field_fc.md @@ -16,26 +16,26 @@ DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container_A |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| field_or_fields_container_B |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |`binary_operation_enum`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_fc.md index abc76c3bdf..186bc5bb58 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_fc.md @@ -16,25 +16,25 @@ Scales a fields container by a constant factor. This factor can be a scalar, a v | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields container to be scaled | -| Pin 1
Required| weights |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Double/Vector of doubles/Field/FieldsContainer. When scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping | -| Pin 2| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Default is false. If set to true, output of scale is made dimensionless | -| Pin 3| algorithm |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Default is 0 use mkl. If set to 1, don't | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields container to be scaled | +| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Double/Vector of doubles/Field/FieldsContainer. When scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping | +| Pin 2| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If set to true, output of scale is made dimensionless | +| Pin 3| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Default is 0 use mkl. If set to 1, don't | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/sin.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/sin.md index 17ecaa9f71..47575b627c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/sin.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/sin.md @@ -16,19 +16,19 @@ Computes element-wise sin(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/sin_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/sin_fc.md index d0b2359017..31e0e68ce7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/sin_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/sin_fc.md @@ -16,19 +16,19 @@ Computes element-wise sin(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/sqr.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/sqr.md index f6748f21df..2984c24798 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/sqr.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/sqr.md @@ -16,22 +16,22 @@ Computes element-wise field[i]^2. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/sqr_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/sqr_fc.md index 4388d596ff..ed4e83c318 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/sqr_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/sqr_fc.md @@ -16,22 +16,22 @@ Computes element-wise field[i]^2. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/sqrt.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/sqrt.md index 5386066a6d..14bace2ce1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/sqrt.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/sqrt.md @@ -16,19 +16,19 @@ Computes element-wise sqrt(field1). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/sqrt_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/sqrt_fc.md index d163dcc4e4..ec5276ace7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/sqrt_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/sqrt_fc.md @@ -16,19 +16,19 @@ Computes element-wise sqrt(field1). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/svd.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/svd.md index ca011b021f..3a51732022 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/svd.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/svd.md @@ -16,21 +16,21 @@ Computes the matrix singular value decomposition (SVD) for each field in the giv | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| s_svd |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Singular values of the input data, where A=U.S.Vt | -| **Pin 1**| u_svd |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | U of the input data, where A=U.S.Vt | -| **Pin 2**| vt_svd |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Vt of the input data, where A=U.S.Vt | +| **Pin 0**| s_svd |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Singular values of the input data, where A=U.S.Vt | +| **Pin 1**| u_svd |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | U of the input data, where A=U.S.Vt | +| **Pin 2**| vt_svd |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Vt of the input data, where A=U.S.Vt | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/sweeping_phase.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/sweeping_phase.md index 908cc05660..c7bdfc63e6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/sweeping_phase.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/sweeping_phase.md @@ -10,30 +10,30 @@ license: None ## Description -Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle (in 3) of a unit (in 4). +Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle (in 3) of a unit (in 4). The resulting field is computed as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| real_field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| imaginary_field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 2
Required| angle |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 3| unit_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | String Unit. Supported values: "deg" or "rad". Default: "rad". | -| Pin 4
Required| abs_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 5
Required| imaginary_part_null |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If the imaginary part field is empty and this pin is true, then the imaginary part is supposed to be 0 (default is false). | +| Pin 0
Required| real_field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| imaginary_field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 2
Required| angle |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 3| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | String Unit. Supported values: "deg" or "rad". Default: "rad". | +| Pin 4
Required| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5
Required| imaginary_part_null |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If the imaginary part field is empty and this pin is true, then the imaginary part is supposed to be 0 (default is false). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/sweeping_phase_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/sweeping_phase_fc.md index 950c014e2b..e21c9648d8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/sweeping_phase_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/sweeping_phase_fc.md @@ -10,28 +10,28 @@ license: None ## Description -Shifts the phase of all the corresponding real and imaginary fields of a fields container for a given angle (in 2) of a unit (in 4). +Shifts the phase of all the corresponding real and imaginary fields of a fields container for a given angle (in 2) of a unit (in 4). An output field is computed for each pair of real and imaginary fields in the input fields_container as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2
Required| angle |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 3| unit_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | String Unit. Supported values: "deg" or "rad". Default: "rad". | -| Pin 4
Required| abs_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 2
Required| angle |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 3| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | String Unit. Supported values: "deg" or "rad". Default: "rad". | +| Pin 4
Required| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/time_derivation.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/time_derivation.md index 0bb9ff2651..0352728766 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/time_derivation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/time_derivation.md @@ -16,20 +16,20 @@ Derives a field of time varying quantities with respect to time | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | field | -| Pin 1| spline_fitting |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Uses spline fitting on the input field to compute smooth derivatives | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | field | +| Pin 1| spline_fitting |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Uses spline fitting on the input field to compute smooth derivatives | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/time_freq_interpolation.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/time_freq_interpolation.md index fcac824528..63c6992525 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/time_freq_interpolation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/time_freq_interpolation.md @@ -16,25 +16,25 @@ Interpolates between all the matching fields of a fields container at given time | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| time_freq_values |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | list of frequencies or times needed. To specify load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". | -| Pin 2| step |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | if a Field is set as input, the step ids should be its scoping. | -| Pin 3| interpolation_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 is ramped, 2 is stepped, default is 1. | -| Pin 4| force_new_time_freq_support |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If set to true, the output fields container will always have a new time freq support rescoped to the output time_freq_values (default is false). If set to false, the time freq support is only recreated when time or frequency values are between existing ones. | -| Pin 8| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| time_freq_values |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | list of frequencies or times needed. To specify load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". | +| Pin 2| step |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if a Field is set as input, the step ids should be its scoping. | +| Pin 3| interpolation_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 is ramped, 2 is stepped, default is 1. | +| Pin 4| force_new_time_freq_support |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true, the output fields container will always have a new time freq support rescoped to the output time_freq_values (default is false). If set to false, the time freq support is only recreated when time or frequency values are between existing ones. | +| Pin 8| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/time_integration.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/time_integration.md index 862a444140..1a14964bbc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/time_integration.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/time_integration.md @@ -16,23 +16,23 @@ Integrates a field of time varying quantities over time | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | field | -| Pin 1| resample_output |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Resample the output | -| Pin 2| absolute_error |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Absolute error for the resampling | -| Pin 3| minimum_step_size |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Minimum time step size for the resamplig | -| Pin 4| integration_constant |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Constant to be added to the integrated field | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | field | +| Pin 1| resample_output |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Resample the output | +| Pin 2| absolute_error |[`double`](../../core-concepts/dpf-types.md#standard-types) | Absolute error for the resampling | +| Pin 3| minimum_step_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | Minimum time step size for the resamplig | +| Pin 4| integration_constant |[`double`](../../core-concepts/dpf-types.md#standard-types) | Constant to be added to the integrated field | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/unit_convert.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/unit_convert.md index 77ae64084b..0467db76e3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/unit_convert.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/unit_convert.md @@ -16,21 +16,21 @@ Converts an input field/fields container or mesh of a given unit to another unit | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| entity_to_convert |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 1
Required| unit_name |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field) | unit as a string, ex 'm' for meter, 'Pa' for pascal,... Or ansys unit system's ID, or a field from which expected unit will be extracted. | +| Pin 0
Required| entity_to_convert |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 1
Required| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | unit as a string, ex 'm' for meter, 'Pa' for pascal,... Or ansys unit system's ID, or a field from which expected unit will be extracted. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| converted_entity |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | the output entity is the same as the input (inplace operator) | +| **Pin 0**| converted_entity |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | the output entity is the same as the input (inplace operator) | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/unit_convert_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/unit_convert_fc.md index deab048c04..a3cc385ed1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/unit_convert_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/unit_convert_fc.md @@ -16,21 +16,21 @@ Converts an input fields container of a given unit to another unit. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| unit_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | unit as a string, ex 'm' for meter, 'Pa' for pascal,... | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | unit as a string, ex 'm' for meter, 'Pa' for pascal,... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_bartlett.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_bartlett.md index 6d0aa22a25..3934a17761 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_bartlett.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_bartlett.md @@ -16,19 +16,19 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_bartlett_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_bartlett_fc.md index 70646d8710..429ad54288 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_bartlett_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_bartlett_fc.md @@ -16,19 +16,19 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_blackman.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_blackman.md index 1c410f8a15..affdcd1b86 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_blackman.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_blackman.md @@ -16,19 +16,19 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_blackman_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_blackman_fc.md index 0ec6a6b090..a61863a0a2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_blackman_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_blackman_fc.md @@ -16,19 +16,19 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hamming.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hamming.md index 60c04f0a5f..e80646b1ed 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hamming.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hamming.md @@ -16,19 +16,19 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hamming_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hamming_fc.md index 7b3aecd433..03e7273bc5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hamming_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hamming_fc.md @@ -16,19 +16,19 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hanning.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hanning.md index 2f3bdc0f94..9f3214aa94 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hanning.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hanning.md @@ -16,19 +16,19 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hanning_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hanning_fc.md index 95ec9be1f4..b58127369c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hanning_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_hanning_fc.md @@ -16,19 +16,19 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_triangular.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_triangular.md index 7b03190600..427e7b2263 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_triangular.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_triangular.md @@ -16,19 +16,19 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_triangular_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_triangular_fc.md index a54fc2f20c..b23b291714 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_triangular_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_triangular_fc.md @@ -16,19 +16,19 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_welch.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_welch.md index 38a285869f..e6f33c5f5e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_welch.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_welch.md @@ -16,19 +16,19 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_welch_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_welch_fc.md index d5cfd458a0..5c02f6f9e5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/window_welch_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/window_welch_fc.md @@ -16,19 +16,19 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/acmo_mesh_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/acmo_mesh_provider.md index 7e0cb31e5b..31cbca7bfc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/acmo_mesh_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/acmo_mesh_provider.md @@ -16,20 +16,20 @@ Converts an Assembly Mesh into a DPF Meshes container | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| assembly_mesh |`ans_dispatch_holder`, `struct IAnsDispatch` | | -| Pin 1| unit |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| assembly_mesh |ans_dispatch_holder, struct IAnsDispatch | | +| Pin 1| unit |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshes_container |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| meshes_container |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/beam_properties.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/beam_properties.md index b20fa6d217..4bbae9f274 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/beam_properties.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/beam_properties.md @@ -16,35 +16,35 @@ Reads the beam's properties from the result files contained in the streams or da | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_out |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | This mesh updates a new map containing a field of the beam's properties if there is at least one beam in mesh. | -| **Pin 1**| field_type_section_id |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the section ID of beams. 1:REC; 3:CSOLID, 4:CTUBE, 5:CHAN, 6:Z, 7:L, 8:I, 9:T, 11:HATS, 12:HREC. | -| **Pin 2**| field_area |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the area of beams. | -| **Pin 3**| field_moment_inertia |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the inertia moment of beams. Iyy, Iyz, Izz. | -| **Pin 4**| field_geometry |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the geometry of beams. REC:b,h. CSOLID:Ri. CTUBE:Ri, Re. CHAN:w1,w2,w3,t1,t2,t3. Z:w1,w2,w3,t1,t2,t3. L:w1,w2,t1,t2. I:w1,w2,w3,t1,t2,t3. T:w1,w2,t1,t2. HATS: w1,w2,w3,w4,t1,t2,t3,t4. HREC:w1,w2,t1,t2,t3,t4. | -| **Pin 5**| field_young_modulus |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the Young's modulus of beams. | -| **Pin 6**| field_poisson_ratio |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the Poisson's ratio of beams. | -| **Pin 7**| field_shear_modulus |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the Shear Modulus of beams. | -| **Pin 8**| field_beam_length |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the length of beams. | -| **Pin 9**| field_torsion_constant |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the Torsion Constant of beams. | -| **Pin 10**| field_warping_constant |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains the Warping Constant of beams. | -| **Pin 11**| field_offset_type |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains offset type of beams. | -| **Pin 12**| field_offset_y |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains offset y of beams. | -| **Pin 13**| field_offset_z |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains offset z of beams. | +| **Pin 0**| mesh_out |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | This mesh updates a new map containing a field of the beam's properties if there is at least one beam in mesh. | +| **Pin 1**| field_type_section_id |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the section ID of beams. 1:REC; 3:CSOLID, 4:CTUBE, 5:CHAN, 6:Z, 7:L, 8:I, 9:T, 11:HATS, 12:HREC. | +| **Pin 2**| field_area |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the area of beams. | +| **Pin 3**| field_moment_inertia |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the inertia moment of beams. Iyy, Iyz, Izz. | +| **Pin 4**| field_geometry |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the geometry of beams. REC:b,h. CSOLID:Ri. CTUBE:Ri, Re. CHAN:w1,w2,w3,t1,t2,t3. Z:w1,w2,w3,t1,t2,t3. L:w1,w2,t1,t2. I:w1,w2,w3,t1,t2,t3. T:w1,w2,t1,t2. HATS: w1,w2,w3,w4,t1,t2,t3,t4. HREC:w1,w2,t1,t2,t3,t4. | +| **Pin 5**| field_young_modulus |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the Young's modulus of beams. | +| **Pin 6**| field_poisson_ratio |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the Poisson's ratio of beams. | +| **Pin 7**| field_shear_modulus |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the Shear Modulus of beams. | +| **Pin 8**| field_beam_length |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the length of beams. | +| **Pin 9**| field_torsion_constant |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the Torsion Constant of beams. | +| **Pin 10**| field_warping_constant |[`field`](../../core-concepts/dpf-types.md#field) | This field contains the Warping Constant of beams. | +| **Pin 11**| field_offset_type |[`field`](../../core-concepts/dpf-types.md#field) | This field contains offset type of beams. | +| **Pin 12**| field_offset_y |[`field`](../../core-concepts/dpf-types.md#field) | This field contains offset y of beams. | +| **Pin 13**| field_offset_z |[`field`](../../core-concepts/dpf-types.md#field) | This field contains offset z of beams. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/change_cs.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/change_cs.md index 6dea171c94..b90eac24cf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/change_cs.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/change_cs.md @@ -16,22 +16,22 @@ Applies a transformation (rotation and displacement) matrix on a mesh or meshes | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| meshes |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 1
Required| coordinate_system |[`field`](./../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix + 3 translations (X, Y, Z) | +| Pin 0
Required| meshes |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 1
Required| coordinate_system |[`field`](../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix + 3 translations (X, Y, Z) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshed_region |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| meshed_region |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/combine_levelset.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/combine_levelset.md index f98b84e45f..5a46d0457a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/combine_levelset.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/combine_levelset.md @@ -16,20 +16,20 @@ Takes two level sets and computes their binary union. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/decimate_mesh.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/decimate_mesh.md index 6d1e64bced..2118d2971c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/decimate_mesh.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/decimate_mesh.md @@ -16,21 +16,21 @@ Decimate a meshed region | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh to decimate | -| Pin 1| preservation_ratio |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Target ratio of elements to preserve, the actual number of elements preserved might differ. Default value is 0.5. | -| Pin 2| aggressiveness |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Quality measure for the resulting decimated mesh. Lower aggresiveness will provide a higher quality mesh with the tradeoff of higher execution time. Value range is 0 to 150, default is 0. | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh to decimate | +| Pin 1| preservation_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types) | Target ratio of elements to preserve, the actual number of elements preserved might differ. Default value is 0.5. | +| Pin 2| aggressiveness |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Quality measure for the resulting decimated mesh. Lower aggresiveness will provide a higher quality mesh with the tradeoff of higher execution time. Value range is 0 to 150, default is 0. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Decimated mesh with triangle elements | +| **Pin 0**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Decimated mesh with triangle elements | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/exclude_levelset.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/exclude_levelset.md index af2b932a6a..10a2556296 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/exclude_levelset.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/exclude_levelset.md @@ -16,20 +16,20 @@ Takes two level sets and excludes the second one from the first. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/external_layer.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/external_layer.md index afc85140ec..553f6a3e7a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/external_layer.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/external_layer.md @@ -16,21 +16,21 @@ Extracts the external layer (thick skin) of the mesh (3D elements) in a new mesh | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| **Pin 1**| nodes_mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| **Pin 2**| elements_mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 1**| nodes_mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| **Pin 2**| elements_mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_field.md index 8c40472991..4422923c0f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_field.md @@ -16,19 +16,19 @@ Returns the meshed region contained in the support of the mesh. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 0**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_scoping.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_scoping.md index a30788ceb4..95d16ebd48 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_scoping.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_scoping.md @@ -10,28 +10,28 @@ license: any_dpf_supported_increments ## Description -Extracts a meshed region from another meshed region based on a scoping. Regarding the property fields of the meshed region: the 'Elemental', 'Face', and 'Nodal' property fields are scoped to the elements, faces or nodes of the output mesh, the 'Global' property fields are transferred from the input mesh to the output mesh without changes, and the rest of the property fields are not present in the output mesh. +Extracts a meshed region from another meshed region based on a scoping. Regarding the property fields whose scoping location is 'Elemental', 'Faces', and 'Nodal', they are scoped to the elements, faces or nodes of the output mesh. The ones whose scoping location is 'Global' are transferred from the input mesh to the output mesh without changes, and the rest of the property fields are not present in the output mesh. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1
Required| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | if nodal/face scoping, then the scoping is transposed respecting the inclusive pin | -| Pin 2| inclusive |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | -| Pin 3| nodes_only |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | returns mesh with nodes only (without any elements or property fields). Default is false. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | if nodal/face scoping, then the scoping is transposed respecting the inclusive pin | +| Pin 2| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | +| Pin 3| nodes_only |[`bool`](../../core-concepts/dpf-types.md#standard-types) | returns mesh with nodes only (without any elements or property fields). Default is false. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 0**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_scopings.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_scopings.md index ed6dd618a6..e7e79021b0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_scopings.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/from_scopings.md @@ -16,22 +16,22 @@ Extracts multiple meshed region base on a scoping and saved in a MeshesContainer | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1
Required| scopings_container |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | if nodal scoping, then the scoping is transposed respecting the inclusive pin | -| Pin 2| inclusive |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | -| Pin 3| nodes_only |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | returns mesh with nodes only (without any elements). Default is false. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| scopings_container |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | if nodal scoping, then the scoping is transposed respecting the inclusive pin | +| Pin 2| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | +| Pin 3| nodes_only |[`bool`](../../core-concepts/dpf-types.md#standard-types) | returns mesh with nodes only (without any elements). Default is false. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshes |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/iso_surfaces.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/iso_surfaces.md index 39fb88c533..07d482a6c7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/iso_surfaces.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/iso_surfaces.md @@ -16,24 +16,24 @@ Extract multiple iso-contours from mesh_cut operator and set it into a meshes co | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | Field containing the values for the iso-surface computation. The mesh can be retrieved from this field's support or through pin 2. | -| Pin 1| num_surfaces |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If provided, iso_values are linearly computed between the min and the max of the field of results. If not, iso_values must be provided by the user through pin 4 | -| Pin 2| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh to compute the iso-surface from. Used when not given through the support of the field in pin 0. | -| Pin 3
Required| slice_surfaces |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | -| Pin 4| vector_iso_values |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | If provided, user defined iso_values to compute. If not provided, iso_values are linearly compute between the min and the max of the field of results. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | Field containing the values for the iso-surface computation. The mesh can be retrieved from this field's support or through pin 2. | +| Pin 1| num_surfaces |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If provided, iso_values are linearly computed between the min and the max of the field of results. If not, iso_values must be provided by the user through pin 4 | +| Pin 2| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh to compute the iso-surface from. Used when not given through the support of the field in pin 0. | +| Pin 3
Required| slice_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | +| Pin 4| vector_iso_values |[`vector`](../../core-concepts/dpf-types.md#standard-types) | If provided, user defined iso_values to compute. If not provided, iso_values are linearly compute between the min and the max of the field of results. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshes |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| **Pin 1**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 1**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/make_plane_levelset.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/make_plane_levelset.md index 966e417d10..5fc707684e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/make_plane_levelset.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/make_plane_levelset.md @@ -16,21 +16,21 @@ Computes the level set for a plane using coordinates. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| coordinates |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| normal |[`field`](./../../core-concepts/dpf-types.md#field) | An overall 3D vector that gives the normal direction of the plane. | -| Pin 2
Required| origin |[`field`](./../../core-concepts/dpf-types.md#field) | An overall 3d vector that gives a point of the plane. | +| Pin 0
Required| coordinates |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| normal |[`field`](../../core-concepts/dpf-types.md#field) | An overall 3D vector that gives the normal direction of the plane. | +| Pin 2
Required| origin |[`field`](../../core-concepts/dpf-types.md#field) | An overall 3d vector that gives a point of the plane. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/make_sphere_levelset.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/make_sphere_levelset.md index c9b92ba870..76a63b9846 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/make_sphere_levelset.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/make_sphere_levelset.md @@ -16,21 +16,21 @@ Computes the level set for a sphere using coordinates. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| coordinates |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| origin |[`field`](./../../core-concepts/dpf-types.md#field) | An overall 3d vector that gives a point of the plane. | -| Pin 2
Required| radius |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Sphere radius. | +| Pin 0
Required| coordinates |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| origin |[`field`](../../core-concepts/dpf-types.md#field) | An overall 3d vector that gives a point of the plane. | +| Pin 2
Required| radius |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sphere radius. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_clip.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_clip.md index 89fcf27978..b59e4cfa35 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_clip.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_clip.md @@ -16,24 +16,24 @@ Clips a volume mesh along an iso value x, and construct the volume mesh defined | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| iso_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | iso value | -| Pin 2
Required| closed_surface |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1: closed surface, 0: iso surface. | -| Pin 3| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 4
Required| slice_surfaces |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| iso_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | iso value | +| Pin 2
Required| closed_surface |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1: closed surface, 0: iso surface. | +| Pin 3| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 4
Required| slice_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 2**| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 2**| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_cut.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_cut.md index ace8ce8e48..1a9444234e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_cut.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_cut.md @@ -16,23 +16,23 @@ Extracts a skin of the mesh in triangles in a new meshed region. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | Field containing the values for the iso-surface computation. The mesh can be retrieved from this field's support or through pin 2. | -| Pin 1
Required| iso_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | iso value | -| Pin 2
Required| closed_surface |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1: closed surface, 0: iso surface. | -| Pin 3| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh to compute the iso-surface from. Used when not given through the support of the field in pin 0. | -| Pin 4
Required| slice_surfaces |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | Field containing the values for the iso-surface computation. The mesh can be retrieved from this field's support or through pin 2. | +| Pin 1
Required| iso_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | iso value | +| Pin 2
Required| closed_surface |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1: closed surface, 0: iso surface. | +| Pin 3| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh to compute the iso-surface from. Used when not given through the support of the field in pin 0. | +| Pin 4
Required| slice_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 2**| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 2**| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_extraction.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_extraction.md index d34bf4bbec..36db74b66a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_extraction.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_extraction.md @@ -16,21 +16,21 @@ Take a mesh and a scoping (elemental or nodal) and create a new mesh that contai | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| extension |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Number of extension layer | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 2| extension |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of extension layer | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 0**| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_get_attribute.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_get_attribute.md index 7bfd7843a1..dac0c3a55f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_get_attribute.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_get_attribute.md @@ -16,21 +16,21 @@ Uses the MeshedRegion APIs to return a given attribute of the mesh in input. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), "coordinates", "named_selection", "num_named_selections", "named_selection_names", "named_selection_locations", "node_scoping", "element_scoping", "face_scoping"... | -| Pin 2| property_identifier |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types) | Can be used to get a property at a given index, example: a named selection's number or by name, example: a named selection's name. | +| Pin 0
Required| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), "coordinates", "named_selection", "num_named_selections", "named_selection_names", "named_selection_locations", "node_scoping", "element_scoping", "face_scoping"... | +| Pin 2| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Can be used to get a property at a given index, example: a named selection's number or by name, example: a named selection's name. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`field`](./../../core-concepts/dpf-types.md#field), [`property_field`](./../../core-concepts/dpf-types.md#property-field), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string_field`](./../../core-concepts/dpf-types.md#string-field) | Returns a property field for properties: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), a field for property: "coordinates", a scoping for properties:"named_selection", "node_scoping", "element_scoping", "face_scoping", a string field for properties: "named_selection_names", "named_selection_locations" and an int for property: "num_named_selections". | +| **Pin 0**| property |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`field`](../../core-concepts/dpf-types.md#field), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string_field`](../../core-concepts/dpf-types.md#string-field) | Returns a property field for properties: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), a field for property: "coordinates", a scoping for properties:"named_selection", "node_scoping", "element_scoping", "face_scoping", a string field for properties: "named_selection_names", "named_selection_locations" and an int for property: "num_named_selections". | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_plan_clip.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_plan_clip.md index 2d03f7bb24..c88a0f84bc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_plan_clip.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_plan_clip.md @@ -16,22 +16,22 @@ Clips a volume mesh along a plane and keeps one side. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh_or_field |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| normal |[`field`](./../../core-concepts/dpf-types.md#field) | An overall 3D vector that gives the normal direction of the plane. | -| Pin 2
Required| origin |[`field`](./../../core-concepts/dpf-types.md#field) | An overall 3D vector that gives a point of the plane. | +| Pin 0
Required| mesh_or_field |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| normal |[`field`](../../core-concepts/dpf-types.md#field) | An overall 3D vector that gives the normal direction of the plane. | +| Pin 2
Required| origin |[`field`](../../core-concepts/dpf-types.md#field) | An overall 3D vector that gives a point of the plane. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 2**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 2**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_provider.md index 44cdaa3922..6a917db40d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_provider.md @@ -16,27 +16,27 @@ Reads a mesh from result files. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Optional time/frequency set ID of the mesh, supported for adaptative meshes. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | If 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids with one entity (vector) or region scoping with one id (scoping) (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 200| laziness |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | configurate whether lazy evaluation can be performed and to what extent. Supported attributes are:
- "num_named_selections"->num named selection to read (-1 is all, int32, default si -1), careful: the other named selections will not be available, use mesh_property_provider Operator to read them.
- all mesh property fields "mat", "named_selection", "apdl_element_type", "section"-> if set to 1 these properties will not be read and a workflow will be bounded to the properties to be evaluated on demand, with 0 they are read (default is 0).
- "all_available_properties" option set to 0 will return all possible properties | +| Pin 0| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Optional time/frequency set ID of the mesh, supported for adaptative meshes. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | If 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids with one entity (vector) or region scoping with one id (scoping) (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 200| laziness |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | configurate whether lazy evaluation can be performed and to what extent. Supported attributes are:
- "num_named_selections"->num named selection to read (-1 is all, int32, default si -1), careful: the other named selections will not be available, use mesh_property_provider Operator to read them.
- all mesh property fields "mat", "named_selection", "apdl_element_type", "section"-> if set to 1 these properties will not be read and a workflow will be bounded to the properties to be evaluated on demand, with 0 they are read (default is 0).
- "all_available_properties" option set to 0 will return all possible properties | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 0**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_graphics.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_graphics.md index 3f5f3a9820..c151688bb1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_graphics.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_graphics.md @@ -16,23 +16,23 @@ Generate tessellation for input mesh | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| node_normals |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | average element normals for node normals (default no, use element normals for node normals) | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 2| node_normals |[`bool`](../../core-concepts/dpf-types.md#standard-types) | average element normals for node normals (default no, use element normals for node normals) | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| nodes |[`field`](./../../core-concepts/dpf-types.md#field) | node coordinates | -| **Pin 1**| normals |[`field`](./../../core-concepts/dpf-types.md#field) | node normals | -| **Pin 2**| connectivity |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | | +| **Pin 0**| nodes |[`field`](../../core-concepts/dpf-types.md#field) | node coordinates | +| **Pin 1**| normals |[`field`](../../core-concepts/dpf-types.md#field) | node normals | +| **Pin 2**| connectivity |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_graphics_edges.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_graphics_edges.md index 95763aa537..3bea963ec2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_graphics_edges.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_graphics_edges.md @@ -16,22 +16,22 @@ Generate edges of surface elements for input mesh | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 6| include_mid_nodes |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 6| include_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| nodes |[`field`](./../../core-concepts/dpf-types.md#field) | node coordinates | -| **Pin 2**| connectivity |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | | +| **Pin 0**| nodes |[`field`](../../core-concepts/dpf-types.md#field) | node coordinates | +| **Pin 2**| connectivity |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_pyvista.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_pyvista.md index 1fc47b1d38..6016fa5574 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_pyvista.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_pyvista.md @@ -16,26 +16,26 @@ Export a MeshedRegion in the pyVista format. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 2| coordinates |[`field`](./../../core-concepts/dpf-types.md#field) | Node coordinates. If not set, the node coordinates of the mesh are employed. | -| Pin 6| as_linear |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Export a linear version of the mesh (quadratic surface elements do no include midside nodes). If not set, defaults to true. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | mesh to export in pyVista format | -| Pin 60| vtk_updated |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | True if the VTK version employed by pyVista is > VTK 9. Default true. | -| Pin 200| as_poly |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Export elements as polyhedrons (cell-face-node representation). Default false. | +| Pin 2| coordinates |[`field`](../../core-concepts/dpf-types.md#field) | Node coordinates. If not set, the node coordinates of the mesh are employed. | +| Pin 6| as_linear |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Export a linear version of the mesh (quadratic surface elements do no include midside nodes). If not set, defaults to true. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh to export in pyVista format | +| Pin 60| vtk_updated |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True if the VTK version employed by pyVista is > VTK 9. Default true. | +| Pin 200| as_poly |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Export elements as polyhedrons (cell-face-node representation). Default false. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| nodes |[`field`](./../../core-concepts/dpf-types.md#field) | Node coordinates double vector | -| **Pin 1**| cells |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Cell connectivity int vector | -| **Pin 2**| cell_types |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Cell types property int vector | -| **Pin 3**| offsets |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | If vtk_updated=false, offsets int vector | +| **Pin 0**| nodes |[`field`](../../core-concepts/dpf-types.md#field) | Node coordinates double vector | +| **Pin 1**| cells |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Cell connectivity int vector | +| **Pin 2**| cell_types |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Cell types property int vector | +| **Pin 3**| offsets |[`vector`](../../core-concepts/dpf-types.md#standard-types) | If vtk_updated=false, offsets int vector | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_tetra.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_tetra.md index 2ecf06120f..2b4719da03 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_tetra.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_to_tetra.md @@ -16,21 +16,21 @@ Converts 3D meshes of arbitrary 3D element types into a tetrahedral mesh, output | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh with arbitrary element types. | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh with arbitrary element types. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Tetrahedralized mesh. | -| **Pin 1**| node_mapping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Node mapping. | -| **Pin 2**| element_mapping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Element mapping. | +| **Pin 0**| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Tetrahedralized mesh. | +| **Pin 1**| node_mapping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Node mapping. | +| **Pin 2**| element_mapping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Element mapping. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/meshes_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/meshes_provider.md index dc3758e638..0fb45d7932 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/meshes_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/meshes_provider.md @@ -16,26 +16,26 @@ Reads meshes from result files. Meshes can be spatially or temporally varying. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | Time/frequency set IDs required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Time/frequency set IDs required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshes |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/morphed_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/morphed_field.md index 1d0995f7c6..15d6e38518 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/morphed_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/morphed_field.md @@ -16,27 +16,27 @@ Computes the displacement to apply on input coordinates (in 2) if a morphing fie | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| displacement |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | expects either a field or a fields container with one field | -| Pin 1| disp_coordinates |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | coordinates on which the displacement field are applied | -| Pin 2
Required| coordinates |[`field`](./../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | coordinates to evaluate | -| Pin 4| morphing_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | morphing algorithm to use (0=PrimeRBF, 1=BSpline, 2=TetLinear, 3=TetRBF, 4=FFI) (default is 0) | +| Pin 0
Required| displacement |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | expects either a field or a fields container with one field | +| Pin 1| disp_coordinates |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | coordinates on which the displacement field are applied | +| Pin 2
Required| coordinates |[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | coordinates to evaluate | +| Pin 4| morphing_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | morphing algorithm to use (0=PrimeRBF, 1=BSpline, 2=TetLinear, 3=TetRBF, 4=FFI) (default is 0) | | Pin 5| morphing_manager_data | | Morphing Manager Data from prepare_morphing_operator (needed if disp_coordinates not specified). | -| Pin 6| sliding_planes |[`field`](./../../core-concepts/dpf-types.md#field) | Sliding planes | -| Pin 7| sliding_nodes |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Sliding nodes | +| Pin 6| sliding_planes |[`field`](../../core-concepts/dpf-types.md#field) | Sliding planes | +| Pin 7| sliding_nodes |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Sliding nodes | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| coordinates_displacement |[`field`](./../../core-concepts/dpf-types.md#field) | displacement of each point of the input coordinates | +| **Pin 0**| coordinates_displacement |[`field`](../../core-concepts/dpf-types.md#field) | displacement of each point of the input coordinates | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/morphing.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/morphing.md index e0692c00fc..ae8bf0ad3f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/morphing.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/morphing.md @@ -16,28 +16,28 @@ Applies morphing on a meshed region depending on an input displacement field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| displacement |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | expects either a field or a fields container with one field | -| Pin 1| disp_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | mesh on which displacement are scoped | -| Pin 2
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | mesh to morph | -| Pin 3| in_place |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Apply in place morhing (the input mesh is changed instead of copied) (default is true) | -| Pin 4| morphing_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | morphing algorithm to use (0=PrimeRBF, 1=BSpline, 2=TetLinear, 3=TetRBF, 4=FFI) (default is 0) | +| Pin 0
Required| displacement |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | expects either a field or a fields container with one field | +| Pin 1| disp_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh on which displacement are scoped | +| Pin 2
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh to morph | +| Pin 3| in_place |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Apply in place morhing (the input mesh is changed instead of copied) (default is true) | +| Pin 4| morphing_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | morphing algorithm to use (0=PrimeRBF, 1=BSpline, 2=TetLinear, 3=TetRBF, 4=FFI) (default is 0) | | Pin 5| morphing_manager_data | | Morphing Manager Data from prepare_morphing_operator (needed if disp_coordinates not specified). | -| Pin 6| sliding_planes |[`field`](./../../core-concepts/dpf-types.md#field) | Sliding planes | -| Pin 7| sliding_nodes |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Sliding nodes | +| Pin 6| sliding_planes |[`field`](../../core-concepts/dpf-types.md#field) | Sliding planes | +| Pin 7| sliding_nodes |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Sliding nodes | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | morphed mesh | +| **Pin 0**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | morphed mesh | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 | | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/node_coordinates.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/node_coordinates.md index 507d7e022c..77c343fad9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/node_coordinates.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/node_coordinates.md @@ -16,19 +16,19 @@ Returns the node coordinates of the mesh(es) in input. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| coordinates |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | if the input is a meshed region, a field of coordinates is the output, else if the input is a meshes container, a fields container (one field by mesh) is the output | +| **Pin 0**| coordinates |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | if the input is a meshed region, a field of coordinates is the output, else if the input is a meshes container, a fields container (one field by mesh) is the output | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/points_from_coordinates.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/points_from_coordinates.md index 1f9bd20aef..c5650d3e88 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/points_from_coordinates.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/points_from_coordinates.md @@ -16,20 +16,20 @@ Extract a mesh made of points elements. This mesh is made from input meshes coor | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| nodes_to_keep |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | | -| Pin 1
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 0
Required| nodes_to_keep |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | +| Pin 1
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 0**| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/prepare_morphing.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/prepare_morphing.md index fb572758cf..ef034abb6e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/prepare_morphing.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/prepare_morphing.md @@ -16,9 +16,9 @@ Prepare morphing on a meshed region depending on an input displacement field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| displacement_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | expects either a scoping or a scopings container with one field | -| Pin 1
Required| disp_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | mesh on which displacement are scoped | -| Pin 2
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | mesh to morph | +| Pin 0
Required| displacement_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | expects either a scoping or a scopings container with one field | +| Pin 1
Required| disp_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh on which displacement are scoped | +| Pin 2
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh to morph | ## Outputs @@ -30,7 +30,7 @@ Prepare morphing on a meshed region depending on an input displacement field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/skin.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/skin.md index fa0d418c27..a2e1ede426 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/skin.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/skin.md @@ -16,26 +16,26 @@ Extracts a skin of the mesh in a new meshed region. The material ID of initial e | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping. | -| Pin 2| duplicate_shell |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If input mesh contains shell elements, output mesh shell elements (boolean = 1) are duplicated, one per each orientation, or (boolean = 0) remain unchanged. | -| Pin 3| add_beam_point |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If input mesh contains beam or point elements, output mesh beam point elements (boolean = 1) are added or (boolean = 0) are ignored. Default: False | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping. | +| Pin 2| duplicate_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If input mesh contains shell elements, output mesh shell elements (boolean = 1) are duplicated, one per each orientation, or (boolean = 0) remain unchanged. | +| Pin 3| add_beam_point |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If input mesh contains beam or point elements, output mesh beam point elements (boolean = 1) are added or (boolean = 0) are ignored. Default: False | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Skin meshed region with facets and facets_to_ele property fields. | -| **Pin 1**| nodes_mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| **Pin 2**| map_new_elements_to_old |`umap` | | -| **Pin 3**| property_field_new_elements_to_old |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | This property field provides, for each new face element ID (in the scoping), the corresponding 3D volume element index (in the data) it has been extracted from. The 3D volume element ID can be found with the element scoping of the input mesh. | -| **Pin 4**| facet_indices |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | This property field gives, for each new face element ID (in the scoping), the corresponding face index on the source 3D volume element. The 3D volume element can be extracted from the previous output. | +| **Pin 0**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Skin meshed region with facets and facets_to_ele property fields. | +| **Pin 1**| nodes_mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| **Pin 2**| map_new_elements_to_old |umap | | +| **Pin 3**| property_field_new_elements_to_old |[`property_field`](../../core-concepts/dpf-types.md#property-field) | This property field provides, for each new face element ID (in the scoping), the corresponding 3D volume element index (in the data) it has been extracted from. The 3D volume element ID can be found with the element scoping of the input mesh. | +| **Pin 4**| facet_indices |[`property_field`](../../core-concepts/dpf-types.md#property-field) | This property field gives, for each new face element ID (in the scoping), the corresponding face index on the source 3D volume element. The 3D volume element can be extracted from the previous output. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/split_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/split_fields.md index f20a5c9739..dfe3881717 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/split_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/split_fields.md @@ -16,20 +16,20 @@ Split the input field or fields container based on the input mesh regions | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| meshes |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | body meshes in the mesh controller cannot be mixed shell/solid | +| Pin 0
Required| field_or_fields_container |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | body meshes in the mesh controller cannot be mixed shell/solid | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/split_mesh.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/split_mesh.md index c77436aabb..e0d74ded6b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/split_mesh.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/split_mesh.md @@ -16,21 +16,21 @@ Split the input mesh into several meshes based on a given property (material pro | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Scoping | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 13
Required| property |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 13
Required| property |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshes |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/stl_export.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/stl_export.md index 1dffa6b152..966c212ea6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/stl_export.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/stl_export.md @@ -16,20 +16,20 @@ export a mesh into a stl file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/tri_mesh_skin.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/tri_mesh_skin.md index d80b4f680d..f46345d3f2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/tri_mesh_skin.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/tri_mesh_skin.md @@ -16,22 +16,22 @@ Extracts a skin of the mesh in triangles in a new meshed region. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1| include_surfaces |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | True: meshing will also take into account shell and skin elements. False: meshing will ignore shell and skin elements. The default is false. | -| Pin 2| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping. | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1| include_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True: meshing will also take into account shell and skin elements. False: meshing will ignore shell and skin elements. The default is false. | +| Pin 2| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| **Pin 1**| nodes_mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 1**| nodes_mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/wireframe.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/wireframe.md index 1a6bd523bb..2e0c114a4c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/wireframe.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/wireframe.md @@ -16,20 +16,20 @@ Take a mesh and extracts its sharp edges, using pin 1 value as a threshold angle | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle threshold in radian that will trigger an edge detection. | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle threshold in radian that will trigger an edge detection. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| wireframe |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 0**| wireframe |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/boundary_condition_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/boundary_condition_provider.md index d49a0304c0..3d87d4f217 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/boundary_condition_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/boundary_condition_provider.md @@ -16,22 +16,22 @@ Reads boundary conditions from the results files contained in the streams or dat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| results_info |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | results info | +| **Pin 0**| results_info |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | results info | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/coordinate_system_data_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/coordinate_system_data_provider.md index b723d0b55f..c4774bdf7f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/coordinate_system_data_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/coordinate_system_data_provider.md @@ -16,23 +16,23 @@ Reads coordinate systems data from the result files contained in the streams or | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| solver_coordinate_system_ids |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | Coorfinate System ids to recover used by the solver. If not set, all available materials to be recovered. | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | +| Pin 1| solver_coordinate_system_ids |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Coorfinate System ids to recover used by the solver. If not set, all available materials to be recovered. | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| coordinate_system_data |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | | +| **Pin 0**| coordinate_system_data |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/cyclic_mesh_expansion.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/cyclic_mesh_expansion.md index c29deacbcc..12ca49b8fc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/cyclic_mesh_expansion.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/cyclic_mesh_expansion.md @@ -16,22 +16,22 @@ Expand the mesh. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 7| sector_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 16
Required| cyclic_support |[`cyclic_support`](./../../core-concepts/dpf-types.md#cyclic-support) | | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | +| Pin 7| sector_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 16
Required| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | expanded meshed region. | -| **Pin 1**| cyclic_support |[`cyclic_support`](./../../core-concepts/dpf-types.md#cyclic-support) | input cyclic support modified in place containing the new expanded meshed regions. | +| **Pin 0**| meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | expanded meshed region. | +| **Pin 1**| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | input cyclic support modified in place containing the new expanded meshed regions. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/cyclic_support_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/cyclic_support_provider.md index ef0bf31262..362aba201f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/cyclic_support_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/cyclic_support_provider.md @@ -16,26 +16,26 @@ Read the cyclic support (DPF entity containing necessary information for expansi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Streams containing the result file. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | data sources containing the result file. | -| Pin 7| sector_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh of the first sector. | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | if this pin is set, expanding the mesh is not necessary. | -| Pin 18| sectors_to_expand |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams containing the result file. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | data sources containing the result file. | +| Pin 7| sector_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh of the first sector. | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | if this pin is set, expanding the mesh is not necessary. | +| Pin 18| sectors_to_expand |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`vector`](../../core-concepts/dpf-types.md#standard-types) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| cyclic_support |[`cyclic_support`](./../../core-concepts/dpf-types.md#cyclic-support) | | -| **Pin 1**| sector_meshes |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | +| **Pin 1**| sector_meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/datasources_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/datasources_provider.md index ed59f2cbdd..cade7667f7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/datasources_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/datasources_provider.md @@ -16,19 +16,19 @@ Creates a DataSources by expanding another. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/element_types_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/element_types_provider.md index 8c32f4d430..668ecd6cea 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/element_types_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/element_types_provider.md @@ -16,23 +16,23 @@ Reads element types data from the result files contained in the streams or data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| solver_element_types_ids |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | Element Type ids to recover used by the solver. If not set, all available element types to be recovered. | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | +| Pin 1| solver_element_types_ids |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Element Type ids to recover used by the solver. If not set, all available element types to be recovered. | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| element_types_data |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | The generic_data_container has a class_name: ElementTypesProperties. It contains the following property fields: element_routine_number: Element routine number. E.g 186 for SOLID186, keyopts: Element type option keys, kdofs: DOF/node for this element type.This is a bit mapping, nodelm: Number of nodes for this element type, nodfor: Number of nodes per element having nodal forces, nodstr: Number of nodes per element having nodal stresses, new_gen_element: Element of new generation. | +| **Pin 0**| element_types_data |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | The generic_data_container has a class_name: ElementTypesProperties. It contains the following property fields: element_routine_number: Element routine number. E.g 186 for SOLID186, keyopts: Element type option keys, kdofs: DOF/node for this element type.This is a bit mapping, nodelm: Number of nodes for this element type, nodfor: Number of nodes per element having nodal forces, nodstr: Number of nodes per element having nodal stresses, new_gen_element: Element of new generation. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/integrate_over_time_freq.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/integrate_over_time_freq.md index ddd6d63d08..436e7df60b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/integrate_over_time_freq.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/integrate_over_time_freq.md @@ -16,21 +16,21 @@ Integration of an input field over timefreq. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Integrate the input field over a specific scoping. | -| Pin 2| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | Time Freq to integrate on, otherwise time freq support from the input field is taken. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Integrate the input field over a specific scoping. | +| Pin 2| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | Time Freq to integrate on, otherwise time freq support from the input field is taken. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/is_cyclic.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/is_cyclic.md index bf0d34c5a7..c303cb81b9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/is_cyclic.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/is_cyclic.md @@ -16,20 +16,21 @@ Reads if the model is cyclic from the result file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | returns 'single_stage' or 'multi_stage' or an empty string for non cyclic model | +| **Pin 0**| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | returns 'single_stage' or 'multi_stage' or an empty string for non cyclic model | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/material_support_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/material_support_provider.md index 36859026d5..405abb59cf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/material_support_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/material_support_provider.md @@ -16,22 +16,22 @@ Reads the material support. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Streams result file container (optional). | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | if the stream is null, get the file path from the data sources. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams result file container (optional). | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | if the stream is null, get the file path from the data sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| abstract_field_support |`abstract_field_support` | | +| **Pin 0**| abstract_field_support |abstract_field_support | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_info_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_info_provider.md index 61a1e53b20..037f7a33e4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_info_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_info_provider.md @@ -16,24 +16,24 @@ Reads the mesh information, such as number of elements (common property), number | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Optional time/frequency set ID of the mesh. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | streams (mesh file container) (optional) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | +| Pin 0| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Optional time/frequency set ID of the mesh. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (mesh file container) (optional) | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_info |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | | +| **Pin 0**| mesh_info |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_property_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_property_provider.md index e960724461..0063a8c834 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_property_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_property_provider.md @@ -16,23 +16,23 @@ Reads a property related to the mesh, defined by its name, by calling the reader | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Retrieves a property field on a subset of elements or nodes. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | -| Pin 13
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "mat", "named_selection", "named_selection_names", "apdl_element_type", "section", "elprops", "keyopt_1" to "keyopt_18". | -| Pin 17| property_identifier |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types) | Retrieves a property at a given index or by name. For example, a named selection's number or a named selection's name. | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Retrieves a property field on a subset of elements or nodes. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | +| Pin 13
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "mat", "named_selection", "named_selection_names", "apdl_element_type", "section", "elprops", "keyopt_1" to "keyopt_18". | +| Pin 17| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Retrieves a property at a given index or by name. For example, a named selection's number or a named selection's name. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`property_field`](./../../core-concepts/dpf-types.md#property-field), [`string_field`](./../../core-concepts/dpf-types.md#string-field) | Returns a property field for properties: "mat", "apdl_element_type", "section", "elprops", "keyopt_1" to "keyopt_18" (or any mesh's property field), a scoping for properties:"named_selection", a string field for properties: "named_selection_names". | +| **Pin 0**| property |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`string_field`](../../core-concepts/dpf-types.md#string-field) | Returns a property field for properties: "mat", "apdl_element_type", "section", "elprops", "keyopt_1" to "keyopt_18" (or any mesh's property field), a scoping for properties:"named_selection", a string field for properties: "named_selection_names". | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_selection_manager_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_selection_manager_provider.md index 0ad5503295..4643c2acd1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_selection_manager_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_selection_manager_provider.md @@ -16,22 +16,22 @@ Reads mesh properties from the results files contained in the streams or data so | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_selection_manager |`mesh_selection_manager` | | +| **Pin 0**| mesh_selection_manager |mesh_selection_manager | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_support_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_support_provider.md index 2f1b3c16c4..2e18f6ddae 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_support_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_support_provider.md @@ -16,22 +16,22 @@ Reads the mesh support. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Streams (result file container) (optional). | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams (result file container) (optional). | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| abstract_field_support |`abstract_field_support` | | +| **Pin 0**| abstract_field_support |abstract_field_support | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/property_field_provider_by_name.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/property_field_provider_by_name.md index 463fbbf915..9566700b41 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/property_field_provider_by_name.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/property_field_provider_by_name.md @@ -16,22 +16,22 @@ Provides the property values for a set of elements for a defined property name. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | scoping that defines the set of elements to fetch the property values for. If not specified, applied on all the elements of the mesh. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | optional if using a dataSources | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | optional if using a streamsContainer | -| Pin 13
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | property to read, that can be the following: elements_connectivity, nodes_connectivity, material, element_type, apdl_section_id, apdl_real_id, apdl_esys_id, mapdl_element_type, mapdl_element_type_id, harmonic_index, step, substep, keyopt_i (i = 1 -> 18). | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | scoping that defines the set of elements to fetch the property values for. If not specified, applied on all the elements of the mesh. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | optional if using a dataSources | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | optional if using a streamsContainer | +| Pin 13
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | property to read, that can be the following: elements_connectivity, nodes_connectivity, material, element_type, apdl_section_id, apdl_real_id, apdl_esys_id, mapdl_element_type, mapdl_element_type_id, harmonic_index, step, substep, keyopt_i (i = 1 -> 18). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property_field |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | property field | +| **Pin 0**| property_field |[`property_field`](../../core-concepts/dpf-types.md#property-field) | property field | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/real_constants_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/real_constants_provider.md index 691d1f37f6..5cf07fa463 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/real_constants_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/real_constants_provider.md @@ -16,23 +16,23 @@ Reads real constants from the result files contained in the streams or data sour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| solver_real_constants_ids |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | Real Constant ids to recover used by the solver. If not set, all available real constants to be recovered. | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | +| Pin 1| solver_real_constants_ids |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Real Constant ids to recover used by the solver. If not set, all available real constants to be recovered. | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| real_constants |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| real_constants |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/result_info_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/result_info_provider.md index 27e078945a..9f37260b5e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/result_info_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/result_info_provider.md @@ -16,23 +16,23 @@ Reads the result information, such as available results or unit systems from the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| result_info |[`result_info`](./../../core-concepts/dpf-types.md#result-info) | | +| **Pin 0**| result_info |[`result_info`](../../core-concepts/dpf-types.md#result-info) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/streams_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/streams_provider.md index ab3ad56047..5b486d1c75 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/streams_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/streams_provider.md @@ -16,21 +16,21 @@ Creates streams (files with cache) from the data sources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | +| **Pin 0**| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_provider.md index d7a5d82597..334898927d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_provider.md @@ -16,22 +16,22 @@ Reads the time/frequency support from the results files contained in the streams | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | +| **Pin 0**| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_support_get_attribute.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_support_get_attribute.md index 50428f4439..1fc97e8f0e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_support_get_attribute.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_support_get_attribute.md @@ -16,22 +16,22 @@ Uses the TimeFreqSupport APIs to return a given attribute of the scoping in inpu | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs". | -| Pin 2| property_identifier |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping. | -| Pin 3| property_identifier_2 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered). | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs". | +| Pin 2| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping. | +| Pin 3| property_identifier_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise. | +| **Pin 0**| property |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_by_component.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_by_component.md index 56fe89825d..e51be42347 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_by_component.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_by_component.md @@ -16,20 +16,20 @@ Give the maximum for each element rank by comparing several fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| use_absolute_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | use_absolute_value | -| Pin 1
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| use_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | use_absolute_value | +| Pin 1
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_over_phase.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_over_phase.md index bb012ddefb..45f3edbbc7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_over_phase.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_over_phase.md @@ -16,22 +16,22 @@ Returns, for each entity, the maximum value of (real value * cos(theta) - imagin | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| real_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| imaginary_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 2| abs_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | -| Pin 3| phase_increment |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Phase increment (default is 10.0 degrees). | +| Pin 0
Required| real_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| imaginary_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 2| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 3| phase_increment |[`double`](../../core-concepts/dpf-types.md#standard-types) | Phase increment (default is 10.0 degrees). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_over_time_by_entity.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_over_time_by_entity.md index 2bfef8b59b..8e69498dbe 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_over_time_by_entity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/max_over_time_by_entity.md @@ -16,22 +16,22 @@ Evaluates maximum over time/frequency. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| abs_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | -| Pin 4| compute_amplitude |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_by_component.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_by_component.md index 2ba47a2e50..915c7df94d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_by_component.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_by_component.md @@ -16,20 +16,20 @@ Give the minimum for each element rank by comparing several fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| use_absolute_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | use_absolute_value | -| Pin 1
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| use_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | use_absolute_value | +| Pin 1
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max.md index 09063366cc..ced80e7b76 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max.md @@ -16,20 +16,20 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_min |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 1**| field_max |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field_min |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 1**| field_max |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_by_entity.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_by_entity.md index 74a519710a..8eb811b6f2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_by_entity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_by_entity.md @@ -16,20 +16,20 @@ Compute the entity-wise minimum (out 0) and maximum (out 1) through all fields o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_min |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 1**| field_max |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field_min |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 1**| field_max |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_by_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_by_time.md index 72b78a55a4..a28adb63da 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_by_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_by_time.md @@ -16,22 +16,22 @@ Evaluates minimum, maximum by time or frequency over all the entities of each fi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2| compute_absolute_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Calculate the absolute value of field entities before computing the min/max. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 2| compute_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the absolute value of field entities before computing the min/max. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| min |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| max |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| min |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| max |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_fc.md index 27cf0ed95b..08e440226b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_fc.md @@ -16,20 +16,20 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_min |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 1**| field_max |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field_min |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 1**| field_max |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_fc_inc.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_fc_inc.md index 2d9f43b8ca..4f87718341 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_fc_inc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_fc_inc.md @@ -16,21 +16,21 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_min |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 1**| field_max |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field_min |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 1**| field_max |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_inc.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_inc.md index ca992293fe..ee206a8268 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_inc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_inc.md @@ -16,23 +16,23 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over coming field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 17| domain_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 17| domain_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_min |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 1**| field_max |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 2**| domain_ids_min |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| **Pin 3**| domain_ids_max |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| field_min |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 1**| field_max |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 2**| domain_ids_min |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| **Pin 3**| domain_ids_max |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_over_label_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_over_label_fc.md index 85d286c7ed..ca73037a35 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_over_label_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_over_label_fc.md @@ -16,25 +16,25 @@ Create two fields (0 min 1 max) by looping over the fields container in input an | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| label |[`string`](./../../core-concepts/dpf-types.md#standard-types) | label name from the fields container | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | label name from the fields container | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_min |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 1**| field_max |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 2**| domain_ids_min |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| **Pin 3**| domain_ids_max |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| **Pin 4**| scoping_ids_min |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| **Pin 5**| scoping_ids_max |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| field_min |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 1**| field_max |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 2**| domain_ids_min |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| **Pin 3**| domain_ids_max |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| **Pin 4**| scoping_ids_min |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| **Pin 5**| scoping_ids_max |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_over_time_by_entity.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_over_time_by_entity.md index 03b98e36c2..86aeb00432 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_over_time_by_entity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_max_over_time_by_entity.md @@ -10,31 +10,34 @@ license: None ## Description -Evaluates minimum, maximum over time/frequency and returns those min max as well as the time/freq where they occurred +For each entity and component, evaluates minimum and maximum over time/frequency. +Input pin 4 `compute_amplitude` is only effective when given `fields_container` contains the `complex` label. +if given input `fields_container` has a `time_freq_support`, output pins 2 and 3 `fields_container` contains time/freq indices of the minimum and maximum values. + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| compute_absolute_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Calculate the absolute value of field entities before computing the min/max. | -| Pin 4| compute_amplitude |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| compute_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the absolute value of field entities before computing the min/max. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| min |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| max |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 2**| time_freq_of_min |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 3**| time_freq_of_max |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| min |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| max |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 2**| time_freq_of_min |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 3**| time_freq_of_max |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_over_time_by_entity.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_over_time_by_entity.md index 22f2668a49..afc6a88ac9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_over_time_by_entity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/min_over_time_by_entity.md @@ -16,22 +16,22 @@ Evaluates minimum over time/frequency. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| abs_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | -| Pin 4| compute_amplitude |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/phase_of_max.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/phase_of_max.md index 3371e5b147..428c10ae4a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/phase_of_max.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/phase_of_max.md @@ -16,22 +16,22 @@ Evaluates phase of maximum. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| real_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| imaginary_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 2| abs_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | -| Pin 3
Required| phase_increment |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Phase increment. | +| Pin 0
Required| real_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| imaginary_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 2| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 3
Required| phase_increment |[`double`](../../core-concepts/dpf-types.md#standard-types) | Phase increment. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/time_of_max_by_entity.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/time_of_max_by_entity.md index 75aecb7871..78ca8f258a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/time_of_max_by_entity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/time_of_max_by_entity.md @@ -16,22 +16,22 @@ Evaluates time/frequency of maximum. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| abs_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | -| Pin 4| compute_amplitude |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/time_of_min_by_entity.md b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/time_of_min_by_entity.md index 1a9acc00fe..83e75cdfa8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/min_max/time_of_min_by_entity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/min_max/time_of_min_by_entity.md @@ -16,21 +16,21 @@ Evaluates time/frequency of minimum. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| abs_value |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | -| Pin 4| compute_amplitude |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration.md index 7d87541d75..49cd74786f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration.md @@ -16,31 +16,31 @@ Read/compute nodal accelerations by calling the readers defined by the datasourc | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_X.md index 3fb8d95138..7f05fb36e9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_X.md @@ -16,28 +16,28 @@ Read/compute nodal accelerations X component of the vector (1st component) by ca | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Y.md index 1e0628fd02..a0f86c9f1f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Y.md @@ -16,28 +16,28 @@ Read/compute nodal accelerations Y component of the vector (2nd component) by ca | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Z.md index b57ebe8ccd..12aa191922 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Z.md @@ -16,28 +16,28 @@ Read/compute nodal accelerations Z component of the vector (3rd component) by ca | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/accu_eqv_creep_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/accu_eqv_creep_strain.md index 80c134844a..ff9b055ff4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/accu_eqv_creep_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/accu_eqv_creep_strain.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal accumulated equivalent creep strain by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal accumulated equivalent creep strain by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/accu_eqv_plastic_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/accu_eqv_plastic_strain.md index feea669583..2dbe09d6dc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/accu_eqv_plastic_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/accu_eqv_plastic_strain.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal accumulated equivalent plastic strain by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal accumulated equivalent plastic strain by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/add_rigid_body_motion.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/add_rigid_body_motion.md index 1634fc82ad..617cd8ddc1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/add_rigid_body_motion.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/add_rigid_body_motion.md @@ -16,23 +16,23 @@ Adds a given rigid translation, center and rotation from a displacement field. T | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| displacement_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| translation_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 2
Required| rotation_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 3
Required| center_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | +| Pin 0
Required| displacement_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| translation_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 2
Required| rotation_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 3
Required| center_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/add_rigid_body_motion_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/add_rigid_body_motion_fc.md index a50496b18d..d49c5740d5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/add_rigid_body_motion_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/add_rigid_body_motion_fc.md @@ -16,23 +16,23 @@ Adds a given rigid translation, center and rotation from a displacement field. T | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| translation_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 2
Required| rotation_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 3
Required| center_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| translation_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 2
Required| rotation_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 3
Required| center_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/artificial_hourglass_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/artificial_hourglass_energy.md index dfc7ced6ce..7752e908c3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/artificial_hourglass_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/artificial_hourglass_energy.md @@ -16,27 +16,27 @@ Read/compute artificial hourglass energy by calling the readers defined by the d | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_force.md index 64e0923a99..7108e6574d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_force.md @@ -4,35 +4,35 @@ plugin: core license: None --- -# result:beam axial force (LSDyna) +# result:beam axial force **Version: 0.0.0** ## Description -Read Beam Axial Force (LSDyna) by calling the readers defined by the datasources. +Read Beam X Axial Force by calling the readers defined by the datasources. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_plastic_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_plastic_strain.md index 0712cf3488..7749cdb9c5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_plastic_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_plastic_strain.md @@ -16,24 +16,24 @@ Read Beam Axial Plastic strain (LSDyna) by calling the readers defined by the da | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_stress.md index badee9885f..ee89578e18 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_stress.md @@ -4,36 +4,36 @@ plugin: core license: None --- -# result:beam axial stress (LSDyna) +# result:beam axial stress **Version: 0.0.0** ## Description -Read Beam Axial Stress (LSDyna) by calling the readers defined by the datasources. +Read Beam X Axial Stress by calling the readers defined by the datasources. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_total_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_total_strain.md index 1ec3121c17..f35229b0af 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_total_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_total_strain.md @@ -4,36 +4,36 @@ plugin: core license: None --- -# result:beam axial total strain (LSDyna) +# result:beam axial total strain **Version: 0.0.0** ## Description -Read Beam Axial Total strain (LSDyna) by calling the readers defined by the datasources. +Read Beam X Axial Total strain by calling the readers defined by the datasources. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_rs_shear_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_rs_shear_stress.md index 4ea4ee6cc6..7ab3581e4f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_rs_shear_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_rs_shear_stress.md @@ -16,24 +16,24 @@ Read Beam RS Shear Stress (LSDyna) by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_bending_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_bending_moment.md index 196fd72516..b13d670d29 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_bending_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_bending_moment.md @@ -4,35 +4,35 @@ plugin: core license: None --- -# result:beam S bending moment (LSDyna) +# result:beam S bending moment **Version: 0.0.0** ## Description -Read Beam S Bending Moment (LSDyna) by calling the readers defined by the datasources. +Read Beam S/Y Bending Moment by calling the readers defined by the datasources. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_shear_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_shear_force.md index 16e239a2b1..b19e507a68 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_shear_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_shear_force.md @@ -4,35 +4,35 @@ plugin: core license: None --- -# result:beam S shear force (LSDyna) +# result:beam S shear force **Version: 0.0.0** ## Description -Read Beam S Shear Force (LSDyna) by calling the readers defined by the datasources. +Read Beam S/Y Shear Force by calling the readers defined by the datasources. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_bending_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_bending_moment.md index f497ae41f9..00a1484cd6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_bending_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_bending_moment.md @@ -4,35 +4,35 @@ plugin: core license: None --- -# result:beam T bending moment (LSDyna) +# result:beam T bending moment **Version: 0.0.0** ## Description -Read Beam T Bending Moment (LSDyna) by calling the readers defined by the datasources. +Read Beam T/Z Bending Moment by calling the readers defined by the datasources. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_shear_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_shear_force.md index a02e3e4d9d..545d60bb18 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_shear_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_shear_force.md @@ -4,35 +4,35 @@ plugin: core license: None --- -# result:beam T shear force (LSDyna) +# result:beam T shear force **Version: 0.0.0** ## Description -Read Beam T Shear Force (LSDyna) by calling the readers defined by the datasources. +Read Beam T/Z Shear Force by calling the readers defined by the datasources. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_torsional_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_torsional_moment.md index 5701527d6f..cc5639188a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_torsional_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_torsional_moment.md @@ -4,35 +4,35 @@ plugin: core license: None --- -# result:beam torsional moment (LSDyna) +# result:beam torsional moment **Version: 0.0.0** ## Description -Read Beam Torsional Moment (LSDyna) by calling the readers defined by the datasources. +Read Beam Torsional Moment by calling the readers defined by the datasources. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_tr_shear_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_tr_shear_stress.md index 2db474b4d0..921922058f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_tr_shear_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_tr_shear_stress.md @@ -16,24 +16,24 @@ Read Beam TR Shear Stress (LSDyna) by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/cgns_result_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/cgns_result_provider.md index d221e81093..76005fca3b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/cgns_result_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/cgns_result_provider.md @@ -16,24 +16,24 @@ Read/compute names result from result streams. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. The scoping's location indicates whether nodes or elements are asked. Using scopings container enables to split the result fields container in domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 17| result_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | name of the result to read. By default the name of the operator is taken. | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | Optional zone name/Id of the mesh. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. The scoping's location indicates whether nodes or elements are asked. Using scopings container enables to split the result fields container in domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 17| result_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | name of the result to read. By default the name of the operator is taken. | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Optional zone name/Id of the mesh. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Results | +| **Pin 0**| fields |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Results | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_dst_table_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_dst_table_provider.md index e11cef933b..3a6e14030f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_dst_table_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_dst_table_provider.md @@ -16,19 +16,19 @@ Read CST table from a subfile. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain at least one subfile). | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain at least one subfile). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| dst_table |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | returns integer values of the dst table | +| **Pin 0**| dst_table |[`property_field`](../../core-concepts/dpf-types.md#property-field) | returns integer values of the dst table | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_matrices_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_matrices_provider.md index 27cfa659cc..867b539153 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_matrices_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_matrices_provider.md @@ -16,20 +16,20 @@ Read reduced matrices for cms elements. Extract stiffness, damping, mass matrice | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain at list one subfile). | -| Pin 200
Required| matrix_form |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If this pin i set to true, data are return as matrix form. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain at list one subfile). | +| Pin 200
Required| matrix_form |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin i set to true, data are return as matrix form. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container containing in this order : stiffness, damping, mass matrices, and then load vector. But if pin 200 is set to true, it's in matrix form. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container containing in this order : stiffness, damping, mass matrices, and then load vector. But if pin 200 is set to true, it's in matrix form. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_subfile_info_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_subfile_info_provider.md index 879519a862..b2c22b507d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_subfile_info_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/cms_subfile_info_provider.md @@ -16,22 +16,22 @@ Read required information from a subfile. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain at least one subfile). | -| Pin 200
Required| cms_subfile_data |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If this pin i set to true, data are return in a field. | -| Pin 300| output_maxdof_on_masternodes |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, compute and add field with max degrees of freedom on master nodes | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain at least one subfile). | +| Pin 200
Required| cms_subfile_data |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin i set to true, data are return in a field. | +| Pin 300| output_maxdof_on_masternodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, compute and add field with max degrees of freedom on master nodes | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| int32 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | returns integer values in the order : unit system used, stiffness matrix present key, damping matrix present key, mass matrix present key, number of master nodes, number of virtual nodes | -| **Pin 1**| field |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | returns integer values in the order : number of load vectors (nvects), number of nodes (nnod), number of virtual nodes (nvnodes), number of modes (nvmodes) | +| **Pin 0**| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | returns integer values in the order : unit system used, stiffness matrix present key, damping matrix present key, mass matrix present key, number of master nodes, number of virtual nodes | +| **Pin 1**| field |[`property_field`](../../core-concepts/dpf-types.md#property-field) | returns integer values in the order : number of load vectors (nvects), number of nodes (nnod), number of virtual nodes (nvnodes), number of modes (nvmodes) | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/co_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/co_energy.md index 4d4fb96e6c..c319e7dcae 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/co_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/co_energy.md @@ -16,27 +16,27 @@ Read/compute co-energy (magnetics) by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_invariant_terms_motion.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_invariant_terms_motion.md index 923d2db17e..8959b9b89f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_invariant_terms_motion.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_invariant_terms_motion.md @@ -16,40 +16,40 @@ Set the required data for the invariant terms computation (reduced matrices, lum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| rom_matrices |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced matrices | -| Pin 1
Required| mode_shapes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | -| Pin 2
Required| lumped_mass |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | -| Pin 3
Required| model_data |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | data describing the finite element model | -| Pin 4
Required| field_coordinates |[`field`](./../../core-concepts/dpf-types.md#field) | coordinates of all nodes | -| Pin 5
Required| nod |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| rom_matrices |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced matrices | +| Pin 1
Required| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | +| Pin 2
Required| lumped_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | +| Pin 3
Required| model_data |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | data describing the finite element model | +| Pin 4
Required| field_coordinates |[`field`](../../core-concepts/dpf-types.md#field) | coordinates of all nodes | +| Pin 5
Required| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| model_data |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | -| **Pin 1**| mode_shapes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | -| **Pin 2**| lumped_mass |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | -| **Pin 3**| field_coordinates_and_euler_angles |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | coordinates and euler angles of all nodes | -| **Pin 4**| nod |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 5**| used_node_index |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 6**| eigenvalue |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 7**| translational_mode_shape |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 8**| rotational_mode_shape |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 9**| invrt_1 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 10**| invrt_2 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 11**| invrt_3 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 12**| invrt_4 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 13**| invrt_5 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 14**| invrt_6 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 15**| invrt_7 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 16**| invrt_8 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | +| **Pin 1**| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | +| **Pin 2**| lumped_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | +| **Pin 3**| field_coordinates_and_euler_angles |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | coordinates and euler angles of all nodes | +| **Pin 4**| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 5**| used_node_index |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 6**| eigenvalue |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 7**| translational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 8**| rotational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 9**| invrt_1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 10**| invrt_2 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 11**| invrt_3 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 12**| invrt_4 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 13**| invrt_5 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 14**| invrt_6 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 15**| invrt_7 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 16**| invrt_8 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_invariant_terms_rbd.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_invariant_terms_rbd.md index 7a1403fb60..6b53b22de2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_invariant_terms_rbd.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_invariant_terms_rbd.md @@ -16,50 +16,50 @@ Set the required data for the invariant terms computation (reduced matrices, lum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| rom_matrices |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced matrices | -| Pin 1
Required| mode_shapes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | -| Pin 2
Required| lumped_mass |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | -| Pin 3
Required| model_data |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | data describing the finite element model | -| Pin 4
Required| center_of_mass |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 5
Required| inertia_relief |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | inertia matrix | -| Pin 6
Required| model_size |[`double`](./../../core-concepts/dpf-types.md#standard-types) | model size | -| Pin 7
Required| field_coordinates |[`field`](./../../core-concepts/dpf-types.md#field) | coordinates of all nodes | -| Pin 8
Required| nod |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 9| constraint_mode_check |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, the orthogonality of the constraint modes are checked. Default is false. | +| Pin 0
Required| rom_matrices |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced matrices | +| Pin 1
Required| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | +| Pin 2
Required| lumped_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | +| Pin 3
Required| model_data |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | data describing the finite element model | +| Pin 4
Required| center_of_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 5
Required| inertia_relief |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | inertia matrix | +| Pin 6
Required| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | model size | +| Pin 7
Required| field_coordinates |[`field`](../../core-concepts/dpf-types.md#field) | coordinates of all nodes | +| Pin 8
Required| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 9| constraint_mode_check |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, the orthogonality of the constraint modes are checked. Default is false. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| model_data |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | -| **Pin 1**| center_of_mass |[`field`](./../../core-concepts/dpf-types.md#field) | center of mass of the body | -| **Pin 2**| inertia_relief |[`field`](./../../core-concepts/dpf-types.md#field) | inertia matrix | -| **Pin 3**| model_size |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | | -| **Pin 4**| master_node_coordinates |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 5**| v_trsf |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | -| **Pin 6**| k_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 7**| mass_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 8**| c_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 9**| rhs |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 10**| dn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 11**| dr_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 12**| drn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 13**| dn_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 14**| dnx_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 15**| dny_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 16**| dnz_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 17**| dyx_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 18**| dyy_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 19**| dyz_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 20**| dnxn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 21**| dnyn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 22**| dnzn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | +| **Pin 1**| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | +| **Pin 2**| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | +| **Pin 3**| model_size |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | +| **Pin 4**| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 5**| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | +| **Pin 6**| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 7**| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 8**| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 9**| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 10**| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 11**| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 12**| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 13**| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 14**| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 15**| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 16**| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 17**| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 18**| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 19**| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 20**| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 21**| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 22**| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress.md index e60500fd90..ae010a670b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_1.md index 898f98a6da..242a2f95c8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_1.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_2.md index 6da434818e..c36f2a1f77 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_2.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_3.md index 34f8593077..6ad5128613 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_3.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_X.md index fcf1ea5a55..fd19f7570b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_X.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_XY.md index 3afa6777bf..2fcfe1d466 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_XY.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_XZ.md index 351373cc81..26c9bb681d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_XZ.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_Y.md index 330051b2db..6e3dc05ee7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_Y.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_YZ.md index f9c6d6223a..9e4fda2ce4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_YZ.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_Z.md index 5fe985123d..801073f45d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_Z.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_von_mises.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_von_mises.md index 4a1901bcaa..2dc1e0c8d6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_von_mises.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_stress_von_mises.md @@ -16,24 +16,24 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10
Required| strain |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain.md index 0cc2436d99..c9fa1052f3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_1.md index 009ca872da..63b8c88a9b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_1.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_2.md index 3458a39287..6ff84e711b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_2.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_3.md index fadd94edf3..27cbbafa34 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_3.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_X.md index f483ccc97f..c948ac6935 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_X.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_XY.md index 079044f7b3..b2410315d2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_XY.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_XZ.md index 5d71262239..5db619997f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_XZ.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_Y.md index fcf00be0b3..fc5919f6a6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_Y.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_YZ.md index 8a508c8ddf..6dc7d367d0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_YZ.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_Z.md index fd13a562ba..6d373a1a79 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/compute_total_strain_Z.md @@ -24,28 +24,28 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files.. Will only be used if no displacement input is given (will be applied on displacement operator). | -| Pin 1| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | -| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | -| Pin 10| displacement |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | +| Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The computed result fields container (elemental nodal). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_fluid_penetration_pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_fluid_penetration_pressure.md index c7dfe1d2ab..85dc5f672d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_fluid_penetration_pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_fluid_penetration_pressure.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element actual applied fluid penetration pressure by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element actual applied fluid penetration pressure by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_friction_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_friction_stress.md index ee66a0a3f3..b0e1f63664 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_friction_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_friction_stress.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element contact friction stress by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element contact friction stress by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_gap_distance.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_gap_distance.md index 1224536b29..b9d898e3cd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_gap_distance.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_gap_distance.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element contact gap distance by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element contact gap distance by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_penetration.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_penetration.md index cc502884e0..68903b3ce7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_penetration.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_penetration.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element contact penetration by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element contact penetration by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_pressure.md index d23a155634..88a23bc15b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_pressure.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element contact pressure by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element contact pressure by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_sliding_distance.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_sliding_distance.md index edf69746da..ba74a18f69 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_sliding_distance.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_sliding_distance.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element contact sliding distance by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element contact sliding distance by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_status.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_status.md index 0e50b7bfd2..59f941c74b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_status.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_status.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element contact status by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element contact status by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_surface_heat_flux.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_surface_heat_flux.md index 5d5cdb8edd..ce33c9cd48 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_surface_heat_flux.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_surface_heat_flux.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element total heat flux at contact surface by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element total heat flux at contact surface by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_total_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_total_stress.md index 4c797dd917..9b434929ab 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_total_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_total_stress.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element contact total stress (pressure plus friction) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element contact total stress (pressure plus friction) by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/coordinate_system.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/coordinate_system.md index 0bc7381f35..d2b2ecb35b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/coordinate_system.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/coordinate_system.md @@ -16,21 +16,21 @@ Extracts the Rotation Matrix and Origin of a specific coordinate system. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| cs_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0
Required| cs_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | the first 9 double are the rotation (3x3 matrix) and the last 3 is the translation vector | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | the first 9 double are the rotation (3x3 matrix) and the last 3 is the translation vector | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/coordinates.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/coordinates.md index 486f9c7bb4..6e54ca2f75 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/coordinates.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/coordinates.md @@ -16,27 +16,27 @@ Read/compute Coordinates (LSDyna) by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain.md new file mode 100644 index 0000000000..4a4deda7d4 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain.md @@ -0,0 +1,93 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain + + **Full name**: result.creep_strain + + **Internal name**: EPCR + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_X.md new file mode 100644 index 0000000000..19d9841d4f --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_X.md @@ -0,0 +1,61 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain X + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_X + + **Full name**: result.creep_strain_X + + **Internal name**: EPCRX + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XY.md new file mode 100644 index 0000000000..698e85027d --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XY.md @@ -0,0 +1,61 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain XY + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_XY + + **Full name**: result.creep_strain_XY + + **Internal name**: EPCRXY + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XZ.md new file mode 100644 index 0000000000..a438c61998 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XZ.md @@ -0,0 +1,61 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain XZ + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_XZ + + **Full name**: result.creep_strain_XZ + + **Internal name**: EPCRXZ + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Y.md new file mode 100644 index 0000000000..72224ec17a --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Y.md @@ -0,0 +1,61 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain Y + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains YY normal component (11 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_Y + + **Full name**: result.creep_strain_Y + + **Internal name**: EPCRY + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_YZ.md new file mode 100644 index 0000000000..6b37657304 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_YZ.md @@ -0,0 +1,61 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain YZ + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains YZ shear component (12 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_YZ + + **Full name**: result.creep_strain_YZ + + **Internal name**: EPCRYZ + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Z.md new file mode 100644 index 0000000000..3589b0ee4d --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Z.md @@ -0,0 +1,61 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain Z + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains ZZ normal component (22 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_Z + + **Full name**: result.creep_strain_Z + + **Internal name**: EPCRZ + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_energy_density.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_energy_density.md index d31b1bd9f1..2f00a9f0fa 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_energy_density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_energy_density.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal creep strain energy density by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal creep strain energy density by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_eqv.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_eqv.md new file mode 100644 index 0000000000..64450f3786 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_eqv.md @@ -0,0 +1,93 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain eqv + +**Version: 0.0.0** + +## Description + +Read/compute element nodal equivalent component creep strains by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_eqv + + **Full name**: result.creep_strain_eqv + + **Internal name**: EPCR_EQV + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_intensity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_intensity.md new file mode 100644 index 0000000000..94c957e2b7 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_intensity.md @@ -0,0 +1,62 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain intensity + +**Version: 0.0.0** + +## Description + +Reads/computes element nodal component creep strains, average it on nodes (by default) and computes its invariants. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_intensity + + **Full name**: result.creep_strain_intensity + + **Internal name**: EPCR_intensity + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_max_shear.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_max_shear.md new file mode 100644 index 0000000000..fa7178f695 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_max_shear.md @@ -0,0 +1,62 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain max_shear + +**Version: 0.0.0** + +## Description + +Reads/computes element nodal component creep strains, average it on nodes (by default) and computes its invariants. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_max_shear + + **Full name**: result.creep_strain_max_shear + + **Internal name**: EPCR_max_shear + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_1.md new file mode 100644 index 0000000000..8d780d9d89 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_1.md @@ -0,0 +1,62 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain principal 1 + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_principal_1 + + **Full name**: result.creep_strain_principal_1 + + **Internal name**: EPCR1 + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_2.md new file mode 100644 index 0000000000..abdf88beee --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_2.md @@ -0,0 +1,62 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain principal 2 + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_principal_2 + + **Full name**: result.creep_strain_principal_2 + + **Internal name**: EPCR2 + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_3.md new file mode 100644 index 0000000000..1f2f2cfcf0 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_3.md @@ -0,0 +1,62 @@ +--- +category: result +plugin: core +license: None +--- + +# result:creep strain principal 3 + +**Version: 0.0.0** + +## Description + +Read/compute element nodal component creep strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: creep_strain_principal_3 + + **Full name**: result.creep_strain_principal_3 + + **Internal name**: EPCR3 + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/current_density.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/current_density.md index c3703aae4a..d6fe72324b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/current_density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/current_density.md @@ -12,31 +12,39 @@ license: None Read/compute Current Density by calling the readers defined by the datasources. + +**Warning**: There are multiple results named "current density". + +This operator returns the elemental "Source current density", also named "JS" in MAPDL and Mechanical. + +To retrieve the result named "current density" in Mechanical or "JC" in MAPDL, use the solver specific operator: `mapdl::rth::JC`. + + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_analytic_seqv_max.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_analytic_seqv_max.md index c23e23631f..6e8bb3c6ca 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_analytic_seqv_max.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_analytic_seqv_max.md @@ -16,26 +16,26 @@ Compute the maximum of the Von Mises equivalent stress that can be expected on 3 | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | default is true | -| Pin 16
Required| cyclic_support |[`cyclic_support`](./../../core-concepts/dpf-types.md#cyclic-support) | | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is true | +| Pin 16
Required| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer filled in | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer filled in | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_analytic_usum_max.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_analytic_usum_max.md index 42fd7d58e6..d91bf97b49 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_analytic_usum_max.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_analytic_usum_max.md @@ -16,26 +16,26 @@ Compute the maximum of the total deformation that can be expected on 360 degrees | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | default is true | -| Pin 16
Required| cyclic_support |[`cyclic_support`](./../../core-concepts/dpf-types.md#cyclic-support) | | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is true | +| Pin 16
Required| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer filled in | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer filled in | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_expansion.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_expansion.md index 83f14a0f89..bf3a9c3668 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_expansion.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_expansion.md @@ -16,32 +16,32 @@ Expand cyclic results from a fieldsContainer for given sets, sectors and scoping | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | -| Pin 3| harmonic_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | default is true | -| Pin 6| map_size_scoping_out |`umap` | map provider by scoping adapter | -| Pin 7| normalization_factor |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| merge_stages |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 16
Required| cyclic_support |[`cyclic_support`](./../../core-concepts/dpf-types.md#cyclic-support) | | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | +| Pin 3| harmonic_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is true | +| Pin 6| map_size_scoping_out |umap | map provider by scoping adapter | +| Pin 7| normalization_factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| merge_stages |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 16
Required| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer filled in | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer filled in | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/density.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/density.md index 30eafe4d6e..69c82f2a8b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/density.md @@ -16,25 +16,25 @@ Read Density by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement.md index f45bea1035..1ac451a4c8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement.md @@ -16,31 +16,31 @@ Read/compute nodal displacements by calling the readers defined by the datasourc | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_X.md index 2c6901c811..16f5ba0df9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_X.md @@ -16,28 +16,28 @@ Read/compute nodal displacements X component of the vector (1st component) by ca | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Y.md index c1e2d9890a..a5a6536dbc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Y.md @@ -16,28 +16,28 @@ Read/compute nodal displacements Y component of the vector (2nd component) by ca | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Z.md index cbdcda7c39..873c78ada3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Z.md @@ -16,28 +16,28 @@ Read/compute nodal displacements Z component of the vector (3rd component) by ca | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/div_lighthill_tensor.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/div_lighthill_tensor.md index 2535a1fed9..3b6a0f8bb1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/div_lighthill_tensor.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/div_lighthill_tensor.md @@ -16,25 +16,25 @@ Read Divergence of the Lighthill Tensor by calling the readers defined by the da | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/dynamic_viscosity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/dynamic_viscosity.md index fa9e6b9e57..c841a0023a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/dynamic_viscosity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/dynamic_viscosity.md @@ -16,25 +16,25 @@ Read Dynamic Viscosity by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain.md index 7332fbf76b..c2d78111c4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element nodal component elastic strains by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal component elastic strains by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_X.md index 107f91a5b2..0036beb52d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_X.md @@ -16,30 +16,30 @@ Read/compute element nodal component elastic strains XX normal component (00 com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XY.md index 9c8472255f..314f700a38 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XY.md @@ -16,30 +16,30 @@ Read/compute element nodal component elastic strains XY shear component (01 comp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XZ.md index 12e4cfc231..8896228889 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XZ.md @@ -16,30 +16,30 @@ Read/compute element nodal component elastic strains XZ shear component (02 comp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Y.md index d11b1db240..b781fbfbb3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Y.md @@ -16,30 +16,30 @@ Read/compute element nodal component elastic strains YY normal component (11 com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_YZ.md index 910102fde0..e612581c82 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_YZ.md @@ -16,30 +16,30 @@ Read/compute element nodal component elastic strains YZ shear component (12 comp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Z.md index e36b3f6477..0a78cb416d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Z.md @@ -16,30 +16,30 @@ Read/compute element nodal component elastic strains ZZ normal component (22 com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_energy_density.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_energy_density.md index b51e86a4e1..09ae68a59f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_energy_density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_energy_density.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal elastic strain energy density by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal elastic strain energy density by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_eqv.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_eqv.md index b5fe40c57c..ff9b701409 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_eqv.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_eqv.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal equivalent elastic strain by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal equivalent elastic strain by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_intensity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_intensity.md index ae384f4bb4..7a6cf5e242 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_intensity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_intensity.md @@ -11,35 +11,36 @@ license: None ## Description Reads/computes element nodal component elastic strains, average it on nodes (by default) and computes its invariants. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_max_shear.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_max_shear.md index 488c8c96cf..11e4530da1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_max_shear.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_max_shear.md @@ -11,35 +11,36 @@ license: None ## Description Reads/computes element nodal component elastic strains, average it on nodes (by default) and computes its invariants. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_1.md index 9e5d105ccf..ef3dd06cd6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_1.md @@ -10,36 +10,37 @@ license: None ## Description -Read/compute element nodal component elastic strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values. +Read/compute element nodal component elastic strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_2.md index e329d354f6..cc876a6d38 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_2.md @@ -10,36 +10,37 @@ license: None ## Description -Read/compute element nodal component elastic strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values. +Read/compute element nodal component elastic strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_3.md index b92db20d47..7954689d74 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_3.md @@ -10,36 +10,37 @@ license: None ## Description -Read/compute element nodal component elastic strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values. +Read/compute element nodal component elastic strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md index f432bb48af..f0c7d1eca4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md @@ -16,21 +16,21 @@ read Euler angles on elements from the result file and rotate the fields in the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream, class dataProcessing::CRstFileWrapper | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field.md index d233531b92..e09bf45c07 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute electric field by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute electric field by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_X.md index bf982e09fa..338442d589 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_X.md @@ -16,30 +16,30 @@ Read/compute electric field X component of the vector (1st component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Y.md index 63bfcdbcc9..d674086ad3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Y.md @@ -16,30 +16,30 @@ Read/compute electric field Y component of the vector (2nd component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Z.md index 21ab650fad..3a0466df67 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Z.md @@ -16,30 +16,30 @@ Read/compute electric field Z component of the vector (3rd component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density.md index 3784455eec..f3bf56d672 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute Electric flux density by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute Electric flux density by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_X.md index e1e7376c7f..0cba48dab3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_X.md @@ -16,30 +16,30 @@ Read/compute Electric flux density X component of the vector (1st component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Y.md index a6a36285ca..60f8608ad2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Y.md @@ -16,30 +16,30 @@ Read/compute Electric flux density Y component of the vector (2nd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Z.md index 5dc47b2ef4..02bc4e8e27 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Z.md @@ -16,30 +16,30 @@ Read/compute Electric flux density Z component of the vector (3rd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_potential.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_potential.md index e276abee2f..74c7c36edf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_potential.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_potential.md @@ -16,27 +16,27 @@ Read/compute electric Potential by calling the readers defined by the datasource | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_centroids.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_centroids.md index ebfd9e48ca..6a40562991 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_centroids.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_centroids.md @@ -16,27 +16,27 @@ Read/compute coordinate of the elemental centroids by calling the readers define | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_nodal_forces.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_nodal_forces.md index dbb1170e28..c3160b56f8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_nodal_forces.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_nodal_forces.md @@ -10,42 +10,73 @@ license: None ## Description -Read/compute element nodal forces by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal forces by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | -| Pin 200| split_force_components |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, the output fields container splits the ENF by degree of freedom ("dof" label, 0 for translation, 1 for rotation, 2 for temperature) and derivative order ("derivative_order" label, 0 for stiffness terms, 1 for damping terms and 2 for inertial terms). Default is false. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | +| Pin 200| split_force_components |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, the output fields container splits the ENF by degree of freedom ("dof" label, 0 for translation, 1 for rotation, 2 for temperature) and derivative order ("derivative_order" label, 0 for stiffness terms, 1 for damping terms and 2 for inertial terms). Default is false. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations.md index 761b102320..70ac9fcfc2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element euler angles by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element euler angles by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_X.md index 7145f6b06f..40142b8434 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_X.md @@ -16,30 +16,30 @@ Read/compute element euler angles X component of the vector (1st component) by c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Y.md index 2d02f8cd0d..b35860a525 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Y.md @@ -16,30 +16,30 @@ Read/compute element euler angles Y component of the vector (2nd component) by c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Z.md index f19dac1da3..c9ef324a03 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Z.md @@ -16,30 +16,30 @@ Read/compute element euler angles Z component of the vector (3rd component) by c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_heat_generation.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_heat_generation.md index 622e46d0fe..14ad0f84e3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_heat_generation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_heat_generation.md @@ -16,27 +16,27 @@ Read/compute Elemental Heat Generation by calling the readers defined by the dat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_mass.md index efb06225dc..0bf0243d8e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_mass.md @@ -16,27 +16,27 @@ Read/compute element mass by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_volume.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_volume.md index d8036ab093..8bf2a282dc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_volume.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_volume.md @@ -16,31 +16,31 @@ Read/compute element volume by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md index fe5a53e085..5f0149a9c7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md @@ -16,21 +16,21 @@ read Euler angles on elements from the result file and rotate the fields in the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream, class dataProcessing::CRstFileWrapper | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/enthalpy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/enthalpy.md index 68ebd0146e..6d79733a4f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/enthalpy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/enthalpy.md @@ -16,25 +16,25 @@ Read Enthalpy by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/entropy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/entropy.md index ac3836eb18..0d57ae3f01 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/entropy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/entropy.md @@ -16,25 +16,25 @@ Read Entropy by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/epsilon.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/epsilon.md index 5204afc8c0..845e403733 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/epsilon.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/epsilon.md @@ -16,25 +16,25 @@ Read Turbulent Dissipation Rate (epsilon) by calling the readers defined by the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_mass.md index ff3fb9929c..7fa63c4b4d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_mass.md @@ -16,31 +16,31 @@ Read/compute equivalent dof mass by calling the readers defined by the datasourc | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| all_dofs |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | default is false. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| all_dofs |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is false. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_radiated_power.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_radiated_power.md index 542f34b956..9e0acc0e68 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_radiated_power.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_radiated_power.md @@ -16,26 +16,26 @@ Compute the Equivalent Radiated Power (ERP) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | the input field container expects displacements fields | -| Pin 1
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | the mesh region in this pin has to be boundary or skin mesh | -| Pin 2
Required| time_scoping |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | load step number (if it's specified, the ERP is computed only on the substeps of this step) or time scoping | -| Pin 3
Required| mass_density |[`double`](./../../core-concepts/dpf-types.md#standard-types) | mass density (if it's not specified, default value of the air is applied). | -| Pin 4
Required| speed_of_sound |[`double`](./../../core-concepts/dpf-types.md#standard-types) | speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | -| Pin 5
Required| erp_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | if this pin is set to 0, the classical ERP is computed, 1 the corrected ERP is computed (a mesh of one face has to be given in the pin 1) and 2 the enhanced ERP is computed. Default is 0. | -| Pin 6
Required| boolean |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, the ERP level in dB is computed | -| Pin 7
Required| factor |[`double`](./../../core-concepts/dpf-types.md#standard-types) | erp reference value. Default is 1E-12 | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | the input field container expects displacements fields | +| Pin 1
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | the mesh region in this pin has to be boundary or skin mesh | +| Pin 2
Required| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | load step number (if it's specified, the ERP is computed only on the substeps of this step) or time scoping | +| Pin 3
Required| mass_density |[`double`](../../core-concepts/dpf-types.md#standard-types) | mass density (if it's not specified, default value of the air is applied). | +| Pin 4
Required| speed_of_sound |[`double`](../../core-concepts/dpf-types.md#standard-types) | speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | +| Pin 5
Required| erp_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to 0, the classical ERP is computed, 1 the corrected ERP is computed (a mesh of one face has to be given in the pin 1) and 2 the enhanced ERP is computed. Default is 0. | +| Pin 6
Required| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, the ERP level in dB is computed | +| Pin 7
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | erp reference value. Default is 1E-12 | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/eqv_stress_parameter.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/eqv_stress_parameter.md index ff8600a925..9718e9bb00 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/eqv_stress_parameter.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/eqv_stress_parameter.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal equivalent stress parameter by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal equivalent stress parameter by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/erp_radiation_efficiency.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/erp_radiation_efficiency.md index b4e32388c6..ca0ecebdf0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/erp_radiation_efficiency.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/erp_radiation_efficiency.md @@ -16,23 +16,23 @@ Compute the radiation efficiency (enhanced erp divided by classical erp) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | the input field container expects displacements fields | -| Pin 1
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | the meshes region in this pin has to be boundary or skin mesh | -| Pin 2
Required| time_scoping |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | load step number (if it's specified, the ERP is computed only on the substeps of this step) or time scoping | -| Pin 3
Required| mass_density |[`double`](./../../core-concepts/dpf-types.md#standard-types) | mass density (if it's not specified, default value of the air is applied). | -| Pin 4
Required| speed_of_sound |[`double`](./../../core-concepts/dpf-types.md#standard-types) | speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | the input field container expects displacements fields | +| Pin 1
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | the meshes region in this pin has to be boundary or skin mesh | +| Pin 2
Required| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | load step number (if it's specified, the ERP is computed only on the substeps of this step) or time scoping | +| Pin 3
Required| mass_density |[`double`](../../core-concepts/dpf-types.md#standard-types) | mass density (if it's not specified, default value of the air is applied). | +| Pin 4
Required| speed_of_sound |[`double`](../../core-concepts/dpf-types.md#standard-types) | speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_load_buckling.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_load_buckling.md index 4cb59e93f6..e526b6a0a3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_load_buckling.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_load_buckling.md @@ -16,24 +16,24 @@ Computing Euler's Critical Load. Formula: Ncr = n*E*I*pi*pi /(L*L) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 5
Required| field_beam_end_condition |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources), [`field`](./../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's end condition added by the user. If there's no file added, it would take value of all beam's end condition as 1. | -| Pin 6
Required| field_beam_moment_inertia |[`field`](./../../core-concepts/dpf-types.md#field) | Field of beam's moment inertia | -| Pin 7
Required| field_beam_young_modulus |[`field`](./../../core-concepts/dpf-types.md#field) | Field of beam's young modulus | -| Pin 8
Required| field_beam_length |[`field`](./../../core-concepts/dpf-types.md#field) | Field of beam's length | +| Pin 5
Required| field_beam_end_condition |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's end condition added by the user. If there's no file added, it would take value of all beam's end condition as 1. | +| Pin 6
Required| field_beam_moment_inertia |[`field`](../../core-concepts/dpf-types.md#field) | Field of beam's moment inertia | +| Pin 7
Required| field_beam_young_modulus |[`field`](../../core-concepts/dpf-types.md#field) | Field of beam's young modulus | +| Pin 8
Required| field_beam_length |[`field`](../../core-concepts/dpf-types.md#field) | Field of beam's length | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_euler_critical_load |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains Euler's Critical Load about the principle axis of the cross section having the least moment of inertia. | -| **Pin 1**| field_euler_critical_load_yy |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains Euler's Critical Load on axis y. | -| **Pin 2**| field_euler_critical_load_zz |[`field`](./../../core-concepts/dpf-types.md#field) | This field contains Euler's Critical Load on axis z. | +| **Pin 0**| field_euler_critical_load |[`field`](../../core-concepts/dpf-types.md#field) | This field contains Euler's Critical Load about the principle axis of the cross section having the least moment of inertia. | +| **Pin 1**| field_euler_critical_load_yy |[`field`](../../core-concepts/dpf-types.md#field) | This field contains Euler's Critical Load on axis y. | +| **Pin 2**| field_euler_critical_load_zz |[`field`](../../core-concepts/dpf-types.md#field) | This field contains Euler's Critical Load on axis z. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_nodes.md index d2525e0239..742994552f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_nodes.md @@ -16,23 +16,23 @@ Reads a field made of 3 coordinates and 3 Euler angles (6 dofs) by node from the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container), `stream` | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5
Required| filter_zeros |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, then the field will only contain the scoping if any rotation is not zero. (default is false). | -| Pin 6
Required| coord_and_euler |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, then the field has ncomp=6 with 3 coordinates and 3 Euler angles, else there is only the Euler angles (default is true). | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 5
Required| filter_zeros |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, then the field will only contain the scoping if any rotation is not zero. (default is false). | +| Pin 6
Required| coord_and_euler |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, then the field has ncomp=6 with 3 coordinates and 3 Euler angles, else there is only the Euler angles (default is true). | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/fluid_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/fluid_velocity.md new file mode 100644 index 0000000000..eac8af00dc --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/fluid_velocity.md @@ -0,0 +1,58 @@ +--- +category: result +plugin: core +license: None +--- + +# result:fluid velocity + +**Version: 0.0.0** + +## Description + +Read/compute FV by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: fluid_velocity + + **Full name**: result.fluid_velocity + + **Internal name**: FV + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure.md index 9a1cc8bae3..fa698e0fe1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure.md @@ -10,37 +10,67 @@ license: None ## Description -Read/compute elemental gasket inelastic closure by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute elemental gasket inelastic closure by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_X.md index a3371a3687..dcd6fa84e9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_X.md @@ -16,30 +16,29 @@ Read/compute elemental gasket inelastic closure XX normal component (00 componen | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XY.md index 770cf4c64a..1095edb909 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XY.md @@ -16,30 +16,29 @@ Read/compute elemental gasket inelastic closure XY shear component (01 component | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md index 64697cd8d1..8f1912eabe 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md @@ -16,30 +16,29 @@ Read/compute elemental gasket inelastic closure XZ shear component (02 component | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress.md index e4d2038f15..52703c00e8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress.md @@ -10,37 +10,67 @@ license: None ## Description -Read/compute elemental gasket stress by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute elemental gasket stress by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_X.md index 96b7a73e20..0222439349 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_X.md @@ -16,30 +16,29 @@ Read/compute elemental gasket stress XX normal component (00 component) by calli | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XY.md index 231ff5de67..e39f6443e6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XY.md @@ -16,30 +16,29 @@ Read/compute elemental gasket stress XY shear component (01 component) by callin | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XZ.md index bbf822d3a8..b0384f34ab 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XZ.md @@ -16,30 +16,29 @@ Read/compute elemental gasket stress XZ shear component (02 component) by callin | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure.md index f428f34322..5390b12d31 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure.md @@ -10,37 +10,67 @@ license: None ## Description -Read/compute elemental gasket thermal closure by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute elemental gasket thermal closure by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_X.md index 2efc4e747c..a4dc278a10 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_X.md @@ -16,30 +16,29 @@ Read/compute elemental gasket thermal closure XX normal component (00 component) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XY.md index 6beb3a1734..a414883287 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XY.md @@ -16,30 +16,29 @@ Read/compute elemental gasket thermal closure XY shear component (01 component) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XZ.md index 88a0883d1b..0cc6f9b3aa 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XZ.md @@ -16,30 +16,29 @@ Read/compute elemental gasket thermal closure XZ shear component (02 component) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure.md new file mode 100644 index 0000000000..833632d1da --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure.md @@ -0,0 +1,58 @@ +--- +category: result +plugin: mapdl +license: None +--- + +# result:gasket total closure + +**Version: 0.0.0** + +## Description + +computes the gasket total closure (sum of gasket thermal closure and gasket inelastic closure). + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: result + + **Plugin**: mapdl + + **Scripting name**: gasket_total_closure + + **Full name**: result.gasket_total_closure + + **Internal name**: GKD + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_X.md new file mode 100644 index 0000000000..44bbd540c2 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_X.md @@ -0,0 +1,60 @@ +--- +category: result +plugin: core +license: None +--- + +# result:gasket total closure X + +**Version: 0.0.0** + +## Description + +Read/compute elemental gasket total closure XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: gasket_total_closure_X + + **Full name**: result.gasket_total_closure_X + + **Internal name**: GKDX + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XY.md new file mode 100644 index 0000000000..f40a9949da --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XY.md @@ -0,0 +1,60 @@ +--- +category: result +plugin: core +license: None +--- + +# result:gasket total closure XY + +**Version: 0.0.0** + +## Description + +Read/compute elemental gasket total closure XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: gasket_total_closure_XY + + **Full name**: result.gasket_total_closure_XY + + **Internal name**: GKDXY + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XZ.md new file mode 100644 index 0000000000..00a4de1a8b --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XZ.md @@ -0,0 +1,60 @@ +--- +category: result +plugin: core +license: None +--- + +# result:gasket total closure XZ + +**Version: 0.0.0** + +## Description + +Read/compute elemental gasket total closure XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: gasket_total_closure_XZ + + **Full name**: result.gasket_total_closure_XZ + + **Internal name**: GKDXZ + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass.md index 079774c860..4b78a2b1dd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass.md @@ -16,21 +16,21 @@ Read Global Added Mass (LSDyna) by calling the readers defined by the datasource | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass_pct.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass_pct.md index bf45834c0b..bdec233526 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass_pct.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass_pct.md @@ -16,21 +16,21 @@ Read Global Added Mass (percentage) (LSDyna) by calling the readers defined by t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_center_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_center_mass.md index e4fc8fdcf9..148d72fbea 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_center_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_center_mass.md @@ -16,21 +16,21 @@ Read Global Center of Mass (LSDyna) by calling the readers defined by the dataso | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio.md index aae78c2078..c40794813d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio.md @@ -16,21 +16,21 @@ Read Global Energy Ratio (LSDyna) by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md index 9a1b261466..b774d08ae8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md @@ -16,21 +16,21 @@ Read Global Energy ratio without Eroded Energy (LSDyna) by calling the readers d | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_hourglass_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_hourglass_energy.md index ab501b2385..48a8df3ddd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_hourglass_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_hourglass_energy.md @@ -16,21 +16,21 @@ Read Global Eroded Hourglass Energy (LSDyna) by calling the readers defined by t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_internal_energy.md index ead1e4306d..2a6b044366 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_internal_energy.md @@ -16,21 +16,21 @@ Read Global Eroded Internal Energy (LSDyna) by calling the readers defined by th | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_kinetic_energy.md index 2277f07432..0bcfde4853 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_kinetic_energy.md @@ -16,21 +16,21 @@ Read Global Eroded Kinetic Energy (LSDyna) by calling the readers defined by the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_external_work.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_external_work.md index 5c9f56c3c7..186ce78e1b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_external_work.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_external_work.md @@ -16,21 +16,21 @@ Read Global External Work (LSDyna) by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_hourglass_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_hourglass_energy.md index 265a381e83..8d7f8ee161 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_hourglass_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_hourglass_energy.md @@ -16,21 +16,21 @@ Read Global Hourglass Energy (LSDyna) by calling the readers defined by the data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_internal_energy.md index fb4e1cc83c..fefa310457 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_internal_energy.md @@ -16,21 +16,21 @@ Read Global Internal Energy (LSDyna) by calling the readers defined by the datas | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_joint_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_joint_internal_energy.md index 926da39a51..1a4132dc21 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_joint_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_joint_internal_energy.md @@ -16,21 +16,21 @@ Read Global Joint Internal Energy (LSDyna) by calling the readers defined by the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_kinetic_energy.md index d18ef72327..86a83933d6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_kinetic_energy.md @@ -16,21 +16,21 @@ Read Global Kinetic Energy (LSDyna) by calling the readers defined by the dataso | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_rigid_body_stopper_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_rigid_body_stopper_energy.md index 793bf961a1..53e686021a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_rigid_body_stopper_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_rigid_body_stopper_energy.md @@ -16,21 +16,21 @@ Read Global Rigid Body Stopper Energy (LSDyna) by calling the readers defined by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_sliding_interface_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_sliding_interface_energy.md index 9246499b00..4a43ed7767 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_sliding_interface_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_sliding_interface_energy.md @@ -16,21 +16,21 @@ Read Global Sliding Interface Energy (LSDyna) by calling the readers defined by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_spring_damper_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_spring_damper_energy.md index 29c2e400b6..05fb7e76ad 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_spring_damper_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_spring_damper_energy.md @@ -16,21 +16,21 @@ Read Global Spring and Damper Energy (LSDyna) by calling the readers defined by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_system_damping_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_system_damping_energy.md index 753d45f920..08f654b6a8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_system_damping_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_system_damping_energy.md @@ -16,21 +16,21 @@ Read Global System Damping Energy (LSDyna) by calling the readers defined by the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_time_step.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_time_step.md index 3a4200ad9e..502f8e4f6c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_time_step.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_time_step.md @@ -16,21 +16,21 @@ Read Global Time Step (LSDyna) by calling the readers defined by the datasources | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_energy.md index 6185441fd3..4feeda3edf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_energy.md @@ -16,21 +16,21 @@ Read Global Total Energy (LSDyna) by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_mass.md index 44037953a8..564bb024d4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_mass.md @@ -16,21 +16,21 @@ Read Global Total Mass (LSDyna) by calling the readers defined by the datasource | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_velocity.md index a75a24a451..3ff1cdfad8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_velocity.md @@ -16,21 +16,21 @@ Read Global Velocity (LSDyna) by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux.md index 71497bb8ee..8f670d1cad 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute heat flux by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute heat flux by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_X.md index e031f17485..0f7fa66e42 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_X.md @@ -16,30 +16,30 @@ Read/compute heat flux X component of the vector (1st component) by calling the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Y.md index d87f8ae36d..7f3a526526 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Y.md @@ -16,30 +16,30 @@ Read/compute heat flux Y component of the vector (2nd component) by calling the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Z.md index 8800b83a1b..6b8f4a7b53 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Z.md @@ -16,30 +16,30 @@ Read/compute heat flux Z component of the vector (3rd component) by calling the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/hydrostatic_pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/hydrostatic_pressure.md index f43d186543..5d89bdf39a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/hydrostatic_pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/hydrostatic_pressure.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal hydrostatic pressure by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal hydrostatic pressure by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/incremental_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/incremental_energy.md index 8528494c14..58efd27d8c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/incremental_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/incremental_energy.md @@ -16,27 +16,27 @@ Read/compute incremental energy (magnetics) by calling the readers defined by th | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/initial_coordinates.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/initial_coordinates.md index 7432f44e8f..753b47316f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/initial_coordinates.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/initial_coordinates.md @@ -16,27 +16,27 @@ Read/compute Initial Coordinates (LSDyna) by calling the readers defined by the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_area.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_area.md index 49b1c1dcfd..4b51cceacf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_area.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_area.md @@ -16,22 +16,22 @@ Read Interface Contact Area (LSDyna) by calling the readers defined by the datas | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_force.md index 5d1bf00203..44b6e9242b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_force.md @@ -16,22 +16,22 @@ Read Interface Contact Force (LSDyna) by calling the readers defined by the data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_mass.md index d92b1e074e..303c2c711c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_mass.md @@ -16,22 +16,22 @@ Read Interface Contact Mass (LSDyna) by calling the readers defined by the datas | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_moment.md index 1f0ea6be54..67e8f7c100 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_moment.md @@ -16,22 +16,22 @@ Read Interface Contact Moment (LSDyna) by calling the readers defined by the dat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_resultant_contact_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_resultant_contact_force.md index 8056818fe3..2146d69a20 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_resultant_contact_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_resultant_contact_force.md @@ -16,22 +16,22 @@ Read Interface Resultant Contact Force (LSDyna) by calling the readers defined b | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_force_reaction.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_force_reaction.md index a75b83c559..78ab2d5657 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_force_reaction.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_force_reaction.md @@ -16,27 +16,27 @@ Read/compute joint force reaction by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_moment_reaction.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_moment_reaction.md index fc871dad13..0bdfd57401 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_moment_reaction.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_moment_reaction.md @@ -16,27 +16,27 @@ Read/compute joint moment reaction by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_acceleration.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_acceleration.md index 7391da1ae6..8d99b2debd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_acceleration.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_acceleration.md @@ -16,27 +16,27 @@ Read/compute joint relative acceleration by calling the readers defined by the d | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_angular_acceleration.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_angular_acceleration.md index 7e475cd83c..1b5af1fe74 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_angular_acceleration.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_angular_acceleration.md @@ -16,27 +16,27 @@ Read/compute joint relative angular acceleration by calling the readers defined | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_angular_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_angular_velocity.md index fe0c7915ce..1f42939f49 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_angular_velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_angular_velocity.md @@ -16,27 +16,27 @@ Read/compute joint relative angular velocity by calling the readers defined by t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_displacement.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_displacement.md index 49a674950e..f9df1d440c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_displacement.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_displacement.md @@ -16,27 +16,27 @@ Read/compute joint relative displacement by calling the readers defined by the d | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_rotation.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_rotation.md index 9cd5c726e0..3a11670859 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_rotation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_rotation.md @@ -16,27 +16,27 @@ Read/compute joint relative rotation by calling the readers defined by the datas | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_velocity.md index 7233303144..699fcc15ab 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/joint_relative_velocity.md @@ -16,27 +16,27 @@ Read/compute joint relative velocity by calling the readers defined by the datas | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/kinetic_energy.md index f842e59f55..0841112fe6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/kinetic_energy.md @@ -16,31 +16,31 @@ Read/compute kinetic energy by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mach_number.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mach_number.md index 1b63ca951f..678e3ce0c7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mach_number.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mach_number.md @@ -16,25 +16,25 @@ Read Mach Number by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field.md index 7ff7c2c58f..efd2b31743 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute Magnetic Field by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute Magnetic Field by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_X.md index 4284d66bb7..4db0b3d85f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_X.md @@ -16,30 +16,30 @@ Read/compute Magnetic Field X component of the vector (1st component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Y.md index d04443d329..53a8f8b495 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Y.md @@ -16,30 +16,30 @@ Read/compute Magnetic Field Y component of the vector (2nd component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Z.md index 6e00232353..2ef6f5f08a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Z.md @@ -16,30 +16,30 @@ Read/compute Magnetic Field Z component of the vector (3rd component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density.md index 977fccb768..d7536f252d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute Magnetic Flux Density by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute Magnetic Flux Density by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_X.md index 9e7c608bd1..2357f31a4b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_X.md @@ -16,30 +16,30 @@ Read/compute Magnetic Flux Density X component of the vector (1st component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Y.md index 1df4eebb89..ec767781f0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Y.md @@ -16,30 +16,30 @@ Read/compute Magnetic Flux Density Y component of the vector (2nd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Z.md index 109f9d3d1c..5409e5e811 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Z.md @@ -16,30 +16,30 @@ Read/compute Magnetic Flux Density Z component of the vector (3rd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_scalar_potential.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_scalar_potential.md index 5c7045744a..9eb3218912 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_scalar_potential.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_scalar_potential.md @@ -16,27 +16,27 @@ Read/compute Magnetic Scalar Potential by calling the readers defined by the dat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_vector_potential.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_vector_potential.md index 39644877a1..e302295440 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_vector_potential.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_vector_potential.md @@ -16,27 +16,27 @@ Read/compute Magnetic Vector Potential by calling the readers defined by the dat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.global_to_nodal.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.global_to_nodal.md index 37e8e1502d..e98ab1e8b6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.global_to_nodal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.global_to_nodal.md @@ -16,20 +16,20 @@ Rotate results from global coordinate system to local coordinate system. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field) | Vector or tensor field that must be rotated, expressed in global coordinate system. | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field) | Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global. | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | Vector or tensor field that must be rotated, expressed in global coordinate system. | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field) | Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | Rotated field | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | Rotated field | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.pres_to_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.pres_to_field.md index 3346029b1e..012576a015 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.pres_to_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.pres_to_field.md @@ -16,20 +16,20 @@ Read the presol generated file from mapdl. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| filepath |[`string`](./../../core-concepts/dpf-types.md#standard-types) | filepath | -| Pin 1| columns_to_read |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | columns_to_read | +| Pin 0
Required| filepath |[`string`](../../core-concepts/dpf-types.md#standard-types) | filepath | +| Pin 1| columns_to_read |[`int32`](../../core-concepts/dpf-types.md#standard-types) | columns_to_read | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.prns_to_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.prns_to_field.md index 66a39e78eb..e588c26c71 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.prns_to_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.prns_to_field.md @@ -16,20 +16,20 @@ Read the presol of nodal field generated file from mapdl. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| filepath |[`string`](./../../core-concepts/dpf-types.md#standard-types) | filepath | -| Pin 1| columns_to_read |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | columns_to_read | +| Pin 0
Required| filepath |[`string`](../../core-concepts/dpf-types.md#standard-types) | filepath | +| Pin 1| columns_to_read |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | columns_to_read | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.run.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.run.md index 8318145f47..d814aae8b3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.run.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl.run.md @@ -16,25 +16,26 @@ Solve in mapdl a dat/inp file and returns a datasources with the rst file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| mapdl_exe_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1| working_dir |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2| number_of_processes |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Set the number of MPI processes used for resolution (default is 2) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | data sources containing the input file. | -| Pin 5| server_mode |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | used when a user includes commands in the input file allowing to launch DPF server inside MAPDL to interact with MAPDL using DPF client API | +| Pin 0| mapdl_exe_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| working_dir |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| number_of_processes |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Set the number of MPI processes used for resolution (default is 2) | +| Pin 3| number_of_threads |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Set the number of threads used for resolution (default is 1) | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | data sources containing the input file. | +| Pin 5| server_mode |[`bool`](../../core-concepts/dpf-types.md#standard-types) | used when a user includes commands in the input file allowing to launch DPF server inside MAPDL to interact with MAPDL using DPF client API | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | returns the data source if the server_mode pin is not set to yes | -| **Pin 1**| ip |[`string`](./../../core-concepts/dpf-types.md#standard-types) | returns the Ip if the server_mode pin is set to yes | -| **Pin 2**| port |[`string`](./../../core-concepts/dpf-types.md#standard-types) | returns a port when the server mode pin is set to yes | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | returns the data source if the server_mode pin is not set to yes | +| **Pin 1**| ip |[`string`](../../core-concepts/dpf-types.md#standard-types) | returns the Ip if the server_mode pin is set to yes | +| **Pin 2**| port |[`string`](../../core-concepts/dpf-types.md#standard-types) | returns a port when the server mode pin is set to yes | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_material_properties.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_material_properties.md index a75c881bd4..d9b450ca33 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_material_properties.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_material_properties.md @@ -16,22 +16,22 @@ Read the values of the properties of a material for a given materials property f | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| properties_name |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1
Required| materials |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | Property field that contains a material id per element. | -| Pin 3
Required| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0
Required| properties_name |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| materials |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Property field that contains a material id per element. | +| Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| properties_value |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| properties_value |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_section.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_section.md index 58848724bb..2020e24b96 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_section.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_section.md @@ -16,25 +16,25 @@ Read the values of the section properties for a given section property field (pr | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| properties_name |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1| section |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | Property field that contains a section id per element.(optional) | -| Pin 3
Required| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5| layer_property |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Property requested is layered. Default = False. | -| Pin 6| layers_requested |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Array with layers requested for the section. Default = AllLayers. | +| Pin 0
Required| properties_name |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| section |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Property field that contains a section id per element.(optional) | +| Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 5| layer_property |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Property requested is layered. Default = False. | +| Pin 6| layers_requested |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Array with layers requested for the section. Default = AllLayers. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| properties_value |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| layers_per_section |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | Only available if layer_property option is set to True. | +| **Pin 0**| properties_value |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| layers_per_section |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Only available if layer_property option is set to True. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_split_on_facet_indices.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_split_on_facet_indices.md index 6c7be9ddc3..08f0ebe229 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_split_on_facet_indices.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_split_on_facet_indices.md @@ -16,24 +16,24 @@ Splits each Field in a FieldsContainer defined on the skin elements of a mesh ac | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container to split, with generic number of labels (e.g. time, zone, complex...), and the Fields of the FieldsContainer will have location Elemental and the Scoping Ids will be the Element Ids on the skin mesh. | -| Pin 1
Required| property_field_new_elements_to_old |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | This property field provides, for each new face element ID (in the scoping), the corresponding 3D volume element index (in the data) it has been extracted from. The 3D volume element ID can be found with the element scoping of the input mesh. | -| Pin 2
Required| facet_indices |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | This property field gives, for each new face element ID (in the scoping), the corresponding face index on the source 3D volume element. The 3D volume element can be extracted from the previous output. | -| Pin 3
Required| volume_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The solid support. | -| Pin 185| degenerated_tets |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Elemental scoping of tet elements. If connected, the tets in the scoping are treated as degenerated tets (SOLID185), and the rest as non-degenerated tets (SOLID285). Pins 185 and 285 are mutually exclusionary (they cannot be connected at the same time), and if none of them is connected, all tets are treated as non-degenerated (SOLID285). | -| Pin 285| non_degenerated_tets |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Elemental scoping of tet elements. If connected, the tets in the scoping are treated as non-degenerated tets (SOLID285), and the rest as degenerated tets (SOLID185). Pins 185 and 285 are mutually exclusionary (they cannot be connected at the same time), and if none of them is connected, all tets are treated as non-degenerated (SOLID285). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container to split, with generic number of labels (e.g. time, zone, complex...), and the Fields of the FieldsContainer will have location Elemental and the Scoping Ids will be the Element Ids on the skin mesh. | +| Pin 1
Required| property_field_new_elements_to_old |[`property_field`](../../core-concepts/dpf-types.md#property-field) | This property field provides, for each new face element ID (in the scoping), the corresponding 3D volume element index (in the data) it has been extracted from. The 3D volume element ID can be found with the element scoping of the input mesh. | +| Pin 2
Required| facet_indices |[`property_field`](../../core-concepts/dpf-types.md#property-field) | This property field gives, for each new face element ID (in the scoping), the corresponding face index on the source 3D volume element. The 3D volume element can be extracted from the previous output. | +| Pin 3
Required| volume_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The solid support. | +| Pin 185| degenerated_tets |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental scoping of tet elements. If connected, the tets in the scoping are treated as degenerated tets (SOLID185), and the rest as non-degenerated tets (SOLID285). Pins 185 and 285 are mutually exclusionary (they cannot be connected at the same time), and if none of them is connected, all tets are treated as non-degenerated (SOLID285). | +| Pin 285| non_degenerated_tets |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental scoping of tet elements. If connected, the tets in the scoping are treated as non-degenerated tets (SOLID285), and the rest as degenerated tets (SOLID185). Pins 185 and 285 are mutually exclusionary (they cannot be connected at the same time), and if none of them is connected, all tets are treated as non-degenerated (SOLID285). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Output splitted fields containter | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Output splitted fields containter | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md index 9c46014259..780920d96b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md @@ -16,20 +16,20 @@ This will retain the already existing labels from the input FC and will change t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container to split, with generic number of labels (e.g. time, zone, complex...), 'facet' label is compulsory.The Fields of the FieldsContainer will have location Elemental and the Scoping Ids will be the Element Ids on the skin mesh. | -| Pin 1
Required| property_fields_container_element_types |[`property_fields_container`](./../../core-concepts/dpf-types.md#property-fields-container) | It should only have the 'facet' label. For each facet, it stores a PropertyField with the element types of the corresponding elements.The scoping should be the same as the scoping of the corresponding Field in input 0. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container to split, with generic number of labels (e.g. time, zone, complex...), 'facet' label is compulsory.The Fields of the FieldsContainer will have location Elemental and the Scoping Ids will be the Element Ids on the skin mesh. | +| Pin 1
Required| property_fields_container_element_types |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | It should only have the 'facet' label. For each facet, it stores a PropertyField with the element types of the corresponding elements.The scoping should be the same as the scoping of the corresponding Field in input 0. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Output splitted fields containter | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Output splitted fields containter | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mass_flow_rate.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mass_flow_rate.md index 47610a68ce..43c8943291 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mass_flow_rate.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mass_flow_rate.md @@ -16,25 +16,25 @@ Read Mass Flow Rate by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mass_fraction.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mass_fraction.md index bdae53ad04..9fa2cdaa2d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mass_fraction.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mass_fraction.md @@ -16,25 +16,25 @@ Read Mass Fraction by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/material_property_of_element.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/material_property_of_element.md index 096bfe233e..a507ced9ef 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/material_property_of_element.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/material_property_of_element.md @@ -16,20 +16,20 @@ Loads the appropriate operator based on the data sources and retrieves material | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| material_properties |[`field`](./../../core-concepts/dpf-types.md#field) | material properties | +| **Pin 0**| material_properties |[`field`](../../core-concepts/dpf-types.md#field) | material properties | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_static_pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_static_pressure.md index 6492865822..2e4a8e7aba 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_static_pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_static_pressure.md @@ -16,25 +16,25 @@ Read Mean Static Pressure by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_temperature.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_temperature.md index 4398ba26bd..795984ab01 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_temperature.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_temperature.md @@ -16,25 +16,25 @@ Read Mean Temperature by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_velocity.md index b8ef3cb90f..cbca598be5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/mean_velocity.md @@ -16,25 +16,25 @@ Read Mean Velocity by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_bending_not_certified.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_bending_not_certified.md index 76748a39fc..400af0665d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_bending_not_certified.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_bending_not_certified.md @@ -16,28 +16,28 @@ This operator is a non-certified example of buckling resistance verification for | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1
Required| field_yield_strength |[`field`](./../../core-concepts/dpf-types.md#field) | This pin contains field of beam's Yield Strength defined by the user. | -| Pin 2
Required| class_cross_section |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Selection for a cross-section. True: Class 1 or 2 cross-sections. False: Class 3 cross section. If the user defines the cross section as class 1 or 2, the section modulus would be plastic section modulus. If it's class 3- cross section,the section modulus would be elastic section modulus | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set. | -| Pin 6
Required| partial_factor |[`double`](./../../core-concepts/dpf-types.md#standard-types) | partial safety factor for resistance of members to instability assessed by member checks. Default value: 1. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh containing beam's properties defined by user | -| Pin 8
Required| bending_moment_y |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis y defined by user | -| Pin 9
Required| bending_moment_z |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis z defined by user | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| field_yield_strength |[`field`](../../core-concepts/dpf-types.md#field) | This pin contains field of beam's Yield Strength defined by the user. | +| Pin 2
Required| class_cross_section |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Selection for a cross-section. True: Class 1 or 2 cross-sections. False: Class 3 cross section. If the user defines the cross section as class 1 or 2, the section modulus would be plastic section modulus. If it's class 3- cross section,the section modulus would be elastic section modulus | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set. | +| Pin 6
Required| partial_factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | partial safety factor for resistance of members to instability assessed by member checks. Default value: 1. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh containing beam's properties defined by user | +| Pin 8
Required| bending_moment_y |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis y defined by user | +| Pin 9
Required| bending_moment_z |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis z defined by user | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| buckling_resistance_bending_yy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of buckling resistance factor on axis y-y in case of bending(M). These factors should be less than 1 and positive. | -| **Pin 1**| buckling_resistance_bending_zz |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of buckling resistance factor on axis z-z in case of bending(M). These factors should be less than 1 and positive. | +| **Pin 0**| buckling_resistance_bending_yy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of buckling resistance factor on axis y-y in case of bending(M). These factors should be less than 1 and positive. | +| **Pin 1**| buckling_resistance_bending_zz |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of buckling resistance factor on axis z-z in case of bending(M). These factors should be less than 1 and positive. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_compression_not_certified.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_compression_not_certified.md index 0a3138945b..62d3892f15 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_compression_not_certified.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_compression_not_certified.md @@ -16,29 +16,29 @@ This operator is a non-certified example of buckling resistance verification for | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | time/freq set ids (use ints or scoping) | -| Pin 1
Required| field_yield_strength |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources), [`field`](./../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's Yield Strength. | -| Pin 2
Required| field_end_condition |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources), [`field`](./../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's end condition defined by the user. If no input at this pin found, it would take end condition's value of all beams as 1. | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set. | -| Pin 5
Required| manufacture |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Manufacturing processus:hot finished if TRUE or cold formed if FALSE. Default value : hot finished. | -| Pin 6
Required| partial_factor |[`double`](./../../core-concepts/dpf-types.md#standard-types) | partial safety factor for resistance of members to instability assessed by member checks. Default value: 1. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh containing beam's properties defined by user | -| Pin 8
Required| axial_force |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of axial force defined by user | -| Pin 12
Required| fabrication_type |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If there is beam I in the structure, please define its fabrication type. True: Rolled section, False: Welded section | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | time/freq set ids (use ints or scoping) | +| Pin 1
Required| field_yield_strength |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's Yield Strength. | +| Pin 2
Required| field_end_condition |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's end condition defined by the user. If no input at this pin found, it would take end condition's value of all beams as 1. | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set. | +| Pin 5
Required| manufacture |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Manufacturing processus:hot finished if TRUE or cold formed if FALSE. Default value : hot finished. | +| Pin 6
Required| partial_factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | partial safety factor for resistance of members to instability assessed by member checks. Default value: 1. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh containing beam's properties defined by user | +| Pin 8
Required| axial_force |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of axial force defined by user | +| Pin 12
Required| fabrication_type |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If there is beam I in the structure, please define its fabrication type. True: Rolled section, False: Welded section | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| buckling_resistance_compression_yy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of buckling resistance factor on axis y-y in case of compression. These factors should be less than 1 and positive. | -| **Pin 1**| buckling_resistance_compression_zz |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of buckling resistance factor on axis z-z in case of compression. These factors should be less than 1 and positive. | +| **Pin 0**| buckling_resistance_compression_yy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of buckling resistance factor on axis y-y in case of compression. These factors should be less than 1 and positive. | +| **Pin 1**| buckling_resistance_compression_zz |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of buckling resistance factor on axis z-z in case of compression. These factors should be less than 1 and positive. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_linear_compression_bending_not_certified.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_linear_compression_bending_not_certified.md index 4a2ad55c97..9dae9584b8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_linear_compression_bending_not_certified.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/members_in_linear_compression_bending_not_certified.md @@ -16,31 +16,31 @@ This operator is a non-certified example of buckling resistance verification for | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1
Required| field_yield_strength |[`field`](./../../core-concepts/dpf-types.md#field) | This pin contains field of beam's Yield Strength defined by the user. | -| Pin 2| field_end_condition |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources), [`field`](./../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's end condition defined by the user. If no input at this pin found, it would take end conditions value of all beams as 1 | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set. | -| Pin 5| manufacture |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Manufacturing processus:hot finished if TRUE or cold formed if FALSE. Default value : hot finished. | -| Pin 6| partial_factor |[`double`](./../../core-concepts/dpf-types.md#standard-types) | partial factor for resistance of members to instability assessed by member checks. Default value: 1.0 | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh containing beam's properties defined by user | -| Pin 8
Required| bending_moment_y |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis y defined by user | -| Pin 9
Required| bending_moment_z |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis z defined by user | -| Pin 10
Required| axial_force |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container of axial force defined by user | -| Pin 11
Required| class_cross_section |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Selection for a cross-section. True: Class 1 or 2 cross-sections. False: Class 3 cross section. If the user defines the cross section as class 1 or 2, the section modulus would be plastic section modulus. If it's class 3- cross section,the section modulus would be elastic section modulus | -| Pin 12| fabrication_type |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Selection of fabrication's type if there are beams I in the structure. TRUE: Rolled Section, False: Welded Section. Default: Rolled Section. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| field_yield_strength |[`field`](../../core-concepts/dpf-types.md#field) | This pin contains field of beam's Yield Strength defined by the user. | +| Pin 2| field_end_condition |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's end condition defined by the user. If no input at this pin found, it would take end conditions value of all beams as 1 | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set. | +| Pin 5| manufacture |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Manufacturing processus:hot finished if TRUE or cold formed if FALSE. Default value : hot finished. | +| Pin 6| partial_factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | partial factor for resistance of members to instability assessed by member checks. Default value: 1.0 | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh containing beam's properties defined by user | +| Pin 8
Required| bending_moment_y |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis y defined by user | +| Pin 9
Required| bending_moment_z |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis z defined by user | +| Pin 10
Required| axial_force |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of axial force defined by user | +| Pin 11
Required| class_cross_section |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Selection for a cross-section. True: Class 1 or 2 cross-sections. False: Class 3 cross section. If the user defines the cross section as class 1 or 2, the section modulus would be plastic section modulus. If it's class 3- cross section,the section modulus would be elastic section modulus | +| Pin 12| fabrication_type |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Selection of fabrication's type if there are beams I in the structure. TRUE: Rolled Section, False: Welded Section. Default: Rolled Section. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| buckling_resistance_linear_summation_utilization_ratios |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Linear summation of the utilization ratios in all members submitted under a combination of both bending and compression. These factors should be less than 1 and positive. | +| **Pin 0**| buckling_resistance_linear_summation_utilization_ratios |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Linear summation of the utilization ratios in all members submitted under a combination of both bending and compression. These factors should be less than 1 and positive. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/migrate_to_h5dpf.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/migrate_to_h5dpf.md index f027dde1fb..56a9c541b7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/migrate_to_h5dpf.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/migrate_to_h5dpf.md @@ -16,28 +16,28 @@ Read mesh properties from the results files contained in the streams or data sou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -5| dataset_size_compression_threshold |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | 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`](./../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree), [`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | 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`](./../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Converts double to float to reduce file size (default is true).If False, nodal results are exported as double precision and elemental results as single precision. | -| Pin 0
Required| filename |[`string`](./../../core-concepts/dpf-types.md#standard-types) | filename of the migrated file | -| Pin 1| comma_separated_list_of_results |[`string`](./../../core-concepts/dpf-types.md#standard-types) | list of results (source operator names) separated by semicolons that will be stored. (Example: U;S;EPEL). If empty, all available results will be converted. | -| Pin 2| all_time_sets |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Deprecated. Please use filtering workflows instead to select time scoping. Default is false. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | if the stream is null then we need to get the file path from the data sources | -| Pin 6| compression_workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow), [`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | BETA Option: Applies input compression workflow. | -| Pin 7| filtering_workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow), [`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Applies input filtering workflow. | +| Pin -5| dataset_size_compression_threshold |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | 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`](../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | 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`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Converts double to float to reduce file size (default is true).If False, nodal results are exported as double precision and elemental results as single precision. | +| Pin 0
Required| filename |[`string`](../../core-concepts/dpf-types.md#standard-types) | filename of the migrated file | +| Pin 1| comma_separated_list_of_results |[`string`](../../core-concepts/dpf-types.md#standard-types) | list of results (source operator names) separated by semicolons that will be stored. (Example: U;S;EPEL). If empty, all available results will be converted. | +| Pin 2| all_time_sets |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Deprecated. Please use filtering workflows instead to select time scoping. Default is false. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | if the stream is null then we need to get the file path from the data sources | +| Pin 6| compression_workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | BETA Option: Applies input compression workflow. | +| Pin 7| filtering_workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Applies input filtering workflow. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| migrated_file |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| **Pin 0**| migrated_file |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_acceleration.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_acceleration.md new file mode 100644 index 0000000000..5360570ca0 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_acceleration.md @@ -0,0 +1,58 @@ +--- +category: result +plugin: core +license: None +--- + +# result:modal acceleration + +**Version: 0.0.0** + +## Description + +Read/compute modal acceleration by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: modal_acceleration + + **Full name**: result.modal_acceleration + + **Internal name**: MAF + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_basis.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_basis.md index c4f951f62f..2cbc43c83d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_basis.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_basis.md @@ -16,27 +16,27 @@ Read/compute modal basis by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_coordinate.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_coordinate.md new file mode 100644 index 0000000000..7dd3ce8027 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_coordinate.md @@ -0,0 +1,58 @@ +--- +category: result +plugin: core +license: None +--- + +# result:modal coordinate + +**Version: 0.0.0** + +## Description + +Read/compute modal coordinate by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: modal_coordinate + + **Full name**: result.modal_coordinate + + **Internal name**: MCF + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_velocity.md new file mode 100644 index 0000000000..af55df5bac --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/modal_velocity.md @@ -0,0 +1,58 @@ +--- +category: result +plugin: core +license: None +--- + +# result:modal velocity + +**Version: 0.0.0** + +## Description + +Read/compute modal velocity by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: modal_velocity + + **Full name**: result.modal_velocity + + **Internal name**: MVF + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nmisc.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nmisc.md index 138db3d3b5..0453735f85 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nmisc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nmisc.md @@ -16,33 +16,33 @@ Read/compute elemental non summable miscellaneous data by calling the readers de | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 10| item_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | -| Pin 11| num_components |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Number of components for the requested item. | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | +| Pin 11| num_components |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of components for the requested item. | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_force.md index 57a7f5b4b3..6abf4fdd0c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_force.md @@ -16,27 +16,27 @@ Read/compute nodal forces by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_moment.md index 31b12b28f7..988d070c97 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_moment.md @@ -16,27 +16,27 @@ Read/compute nodal moment by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation.md new file mode 100644 index 0000000000..fab135b338 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation.md @@ -0,0 +1,58 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotation + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotation by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotation + + **Full name**: result.nodal_rotation + + **Internal name**: ROT + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_X.md new file mode 100644 index 0000000000..1582579c8c --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_X.md @@ -0,0 +1,59 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotation X + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotation X component of the vector (1st component) by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotation_X + + **Full name**: result.nodal_rotation_X + + **Internal name**: ROTX + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Y.md new file mode 100644 index 0000000000..19f1cafc24 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Y.md @@ -0,0 +1,59 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotation Y + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotation Y component of the vector (2nd component) by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotation_Y + + **Full name**: result.nodal_rotation_Y + + **Internal name**: ROTY + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Z.md new file mode 100644 index 0000000000..b0c0c9cdf4 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Z.md @@ -0,0 +1,59 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotation Z + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotation Z component of the vector (3rd component) by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotation_Z + + **Full name**: result.nodal_rotation_Z + + **Internal name**: ROTZ + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration.md new file mode 100644 index 0000000000..f6a768d600 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration.md @@ -0,0 +1,58 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotational acceleration + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotational acceleration by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotational_acceleration + + **Full name**: result.nodal_rotational_acceleration + + **Internal name**: DMG + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_X.md new file mode 100644 index 0000000000..3ab56b8e5b --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_X.md @@ -0,0 +1,59 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotational acceleration X + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotational acceleration X component of the vector (1st component) by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotational_acceleration_X + + **Full name**: result.nodal_rotational_acceleration_X + + **Internal name**: DMGX + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md new file mode 100644 index 0000000000..f5a42d46dc --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md @@ -0,0 +1,59 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotational acceleration Y + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotational acceleration Y component of the vector (2nd component) by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotational_acceleration_Y + + **Full name**: result.nodal_rotational_acceleration_Y + + **Internal name**: DMGY + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md new file mode 100644 index 0000000000..6e8b3a8210 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md @@ -0,0 +1,59 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotational acceleration Z + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotational acceleration Z component of the vector (3rd component) by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotational_acceleration_Z + + **Full name**: result.nodal_rotational_acceleration_Z + + **Internal name**: DMGZ + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity.md new file mode 100644 index 0000000000..506e6b8500 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity.md @@ -0,0 +1,58 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotational velocity + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotational velocity by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotational_velocity + + **Full name**: result.nodal_rotational_velocity + + **Internal name**: OMG + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_X.md new file mode 100644 index 0000000000..5691e522f7 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_X.md @@ -0,0 +1,59 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotational velocity X + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotational velocity X component of the vector (1st component) by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotational_velocity_X + + **Full name**: result.nodal_rotational_velocity_X + + **Internal name**: OMGX + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Y.md new file mode 100644 index 0000000000..d92f04794a --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Y.md @@ -0,0 +1,59 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotational velocity Y + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotational velocity Y component of the vector (2nd component) by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotational_velocity_Y + + **Full name**: result.nodal_rotational_velocity_Y + + **Internal name**: OMGY + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Z.md new file mode 100644 index 0000000000..2582b21a5e --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Z.md @@ -0,0 +1,59 @@ +--- +category: result +plugin: core +license: None +--- + +# result:nodal rotational velocity Z + +**Version: 0.0.0** + +## Description + +Read/compute nodal rotational velocity Z component of the vector (3rd component) by calling the readers defined by the datasources. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | + +## Scripting + + **Category**: result + + **Plugin**: core + + **Scripting name**: nodal_rotational_velocity_Z + + **Full name**: result.nodal_rotational_velocity_Z + + **Internal name**: OMGZ + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_to_global.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_to_global.md index e930222b7c..4f84e9f67f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_to_global.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_to_global.md @@ -16,20 +16,20 @@ Rotates nodal elemental results to global coordinate system | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](./../../core-concepts/dpf-types.md#field) | Vector or tensor field that must be rotated, expressed in nodal coordinate system. | -| Pin 1
Required| fieldB |[`field`](./../../core-concepts/dpf-types.md#field) | Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global. | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | Vector or tensor field that must be rotated, expressed in nodal coordinate system. | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field) | Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | Rotated field | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | Rotated field | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/normal_contact_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/normal_contact_force.md index 8b8347d0d3..2beaafe124 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/normal_contact_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/normal_contact_force.md @@ -16,27 +16,27 @@ Read/compute normal contact force by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/normal_contact_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/normal_contact_moment.md index 3424234f87..4838de2b42 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/normal_contact_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/normal_contact_moment.md @@ -16,27 +16,27 @@ Read/compute normal contact moment by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/num_surface_status_changes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/num_surface_status_changes.md index 9606f950bf..bbb41fdd46 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/num_surface_status_changes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/num_surface_status_changes.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element total number of contact status changes during substep by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element total number of contact status changes during substep by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/omega.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/omega.md index 482169502a..355468aed7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/omega.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/omega.md @@ -16,25 +16,25 @@ Read Turbulent Specific Dissipation Rate (omega) by calling the readers defined | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_added_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_added_mass.md index 63cb024f8f..74c8007310 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_added_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_added_mass.md @@ -16,22 +16,22 @@ Read Part Added Mass (LSDyna) by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_internal_energy.md index 30c53d93fd..287893f3e7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_internal_energy.md @@ -16,22 +16,22 @@ Read Part Eroded Internal Energy (LSDyna) by calling the readers defined by the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_kinetic_energy.md index a2eed929fb..f955afabcc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_kinetic_energy.md @@ -16,22 +16,22 @@ Read Part Eroded Kinetic Energy (LSDyna) by calling the readers defined by the d | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_hourglass_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_hourglass_energy.md index 190dd904d0..7416d05b79 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_hourglass_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_hourglass_energy.md @@ -16,22 +16,22 @@ Read Part Hourglass Energy (LSDyna) by calling the readers defined by the dataso | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_internal_energy.md index 65ee3d1355..d905a24a0f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_internal_energy.md @@ -16,22 +16,22 @@ Read Part Internal Energy (LSDyna) by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_kinetic_energy.md index cf4919a339..f91f480cf8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_kinetic_energy.md @@ -16,22 +16,22 @@ Read Part Kinetic Energy (LSDyna) by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_momentum.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_momentum.md index 05a2032265..e9efbd047f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_momentum.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_momentum.md @@ -16,22 +16,22 @@ Read Part Momentum (LSDyna) by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_rigid_body_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_rigid_body_velocity.md index b404c4eec0..f8bf4231b0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_rigid_body_velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_rigid_body_velocity.md @@ -16,22 +16,22 @@ Read Part Rigid Body Velocity (LSDyna) by calling the readers defined by the dat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| entity_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_state_variable.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_state_variable.md index 0b4c71acf6..24b02f2ad0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_state_variable.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_state_variable.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal plastic state variable by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal plastic state variable by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain.md index 220a0fdb10..fbe1d31f55 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal component plastic strains by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal component plastic strains by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_X.md index 33fc9ff9dd..55df0c9be1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_X.md @@ -16,30 +16,30 @@ Read/compute element nodal component plastic strains XX normal component (00 com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XY.md index e5c0d3f7af..3aa35e5f03 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XY.md @@ -16,30 +16,30 @@ Read/compute element nodal component plastic strains XY shear component (01 comp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XZ.md index 307fb0bafa..31ddd2b307 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XZ.md @@ -16,30 +16,30 @@ Read/compute element nodal component plastic strains XZ shear component (02 comp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Y.md index b0cc9ba3b6..feef066ff4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Y.md @@ -16,30 +16,30 @@ Read/compute element nodal component plastic strains YY normal component (11 com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_YZ.md index 75405ca3bd..f6726b3ff0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_YZ.md @@ -16,30 +16,30 @@ Read/compute element nodal component plastic strains YZ shear component (12 comp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Z.md index 32497c6971..17e7280e05 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Z.md @@ -16,30 +16,30 @@ Read/compute element nodal component plastic strains ZZ normal component (22 com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_energy_density.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_energy_density.md index 5f0bea438c..c9754cdc33 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_energy_density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_energy_density.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal plastic strain energy density by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal plastic strain energy density by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_eqv.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_eqv.md index e164f1296a..63d1e0b970 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_eqv.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_eqv.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal equivalent plastic strain by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal equivalent plastic strain by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_intensity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_intensity.md index fd8a8903ef..48849ec3d8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_intensity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_intensity.md @@ -11,35 +11,36 @@ license: None ## Description Reads/computes element nodal component plastic strains, average it on nodes (by default) and computes its invariants. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_max_shear.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_max_shear.md index 25681b7d66..4e05a58881 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_max_shear.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_max_shear.md @@ -11,35 +11,36 @@ license: None ## Description Reads/computes element nodal component plastic strains, average it on nodes (by default) and computes its invariants. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_1.md index e07b3ca09d..4cc131eb40 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_1.md @@ -10,36 +10,37 @@ license: None ## Description -Read/compute element nodal component plastic strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values. +Read/compute element nodal component plastic strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_2.md index 48840021fe..0b59836ac4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_2.md @@ -10,36 +10,37 @@ license: None ## Description -Read/compute element nodal component plastic strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values. +Read/compute element nodal component plastic strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_3.md index 952d7fb259..a0d1dbca26 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_3.md @@ -10,36 +10,37 @@ license: None ## Description -Read/compute element nodal component plastic strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values. +Read/compute element nodal component plastic strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md index a0075c3f2f..92111fa5bd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md @@ -16,21 +16,21 @@ read Euler angles on elements from the result file and rotate the fields in the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream, class dataProcessing::CRstFileWrapper | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/poynting_vector.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/poynting_vector.md index 27a902c34f..37809d3044 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/poynting_vector.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/poynting_vector.md @@ -16,24 +16,24 @@ Compute the Poynting Vector | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_containerA |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| fields_containerB |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2
Required| fields_containerC |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3
Required| fields_containerD |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 4| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | the mesh region in this pin have to be boundary or skin mesh | -| Pin 5| int32 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step | +| Pin 0
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 2
Required| fields_containerC |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3
Required| fields_containerD |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 4| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | the mesh region in this pin have to be boundary or skin mesh | +| Pin 5| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/poynting_vector_surface.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/poynting_vector_surface.md index 21a26b305a..8b3f9225cf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/poynting_vector_surface.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/poynting_vector_surface.md @@ -16,24 +16,24 @@ Compute the Poynting Vector surface integral | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_containerA |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| fields_containerB |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2
Required| fields_containerC |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3
Required| fields_containerD |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 4| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | the mesh region in this pin have to be boundary or skin mesh | -| Pin 5| int32 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step | +| Pin 0
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 2
Required| fields_containerC |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3
Required| fields_containerD |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 4| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | the mesh region in this pin have to be boundary or skin mesh | +| Pin 5| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/pressure.md index 0a72a2e368..9eb9667825 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/pressure.md @@ -16,27 +16,27 @@ Read/compute Pressure by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/pretension.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/pretension.md index 2bcf26bdf0..bd43af84aa 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/pretension.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/pretension.md @@ -16,29 +16,29 @@ Reads the pretension adjustment and tension force. Rotation is not allowed for t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3
Required| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container), `stream` | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 0| time_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| adjustment |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Adjustment | -| **Pin 1**| tension_force |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Tension Force | +| **Pin 0**| adjustment |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Adjustment | +| **Pin 1**| tension_force |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Tension Force | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/raw_displacement.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/raw_displacement.md index 70a46e65cf..43b21afbc5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/raw_displacement.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/raw_displacement.md @@ -16,27 +16,27 @@ Read/compute U vector from the finite element problem KU=F by calling the reader | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/raw_reaction_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/raw_reaction_force.md index b3330fda42..aa6dfc85bf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/raw_reaction_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/raw_reaction_force.md @@ -16,27 +16,27 @@ Read/compute F vector from the finite element problem KU=F by calling the reader | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force.md index b5b974ded6..8d2616ce62 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force.md @@ -16,27 +16,27 @@ Read/compute nodal reaction forces by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_X.md index fe3502f039..6d78ddef74 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_X.md @@ -16,28 +16,28 @@ Read/compute nodal reaction forces X component of the vector (1st component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Y.md index 861ae66f51..699213ba2b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Y.md @@ -16,28 +16,28 @@ Read/compute nodal reaction forces Y component of the vector (2nd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Z.md index 5f32ef7d9e..fd90e72936 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Z.md @@ -16,28 +16,28 @@ Read/compute nodal reaction forces Z component of the vector (3rd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/read_cms_rbd_file.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/read_cms_rbd_file.md index 74710a0860..4ca1dfe5cd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/read_cms_rbd_file.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/read_cms_rbd_file.md @@ -16,41 +16,41 @@ Read the invariant terms and the model data from a cms_rbd file | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| in_cms_rbd_file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | file name with cms_rbd extension where to read the input cms_rbd file. | +| Pin 0
Required| in_cms_rbd_file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | file name with cms_rbd extension where to read the input cms_rbd file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| model_data |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | -| **Pin 1**| center_of_mass |[`field`](./../../core-concepts/dpf-types.md#field) | center of mass of the body | -| **Pin 2**| inertia_relief |[`field`](./../../core-concepts/dpf-types.md#field) | inertia matrix | -| **Pin 3**| model_size |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | | -| **Pin 4**| master_node_coordinates |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 5**| v_trsf |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | -| **Pin 6**| k_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 7**| mass_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 8**| c_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 9**| rhs |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 10**| dn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 11**| dr_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 12**| drn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 13**| dn_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 14**| dnx_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 15**| dny_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 16**| dnz_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 17**| dyx_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 18**| dyy_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 19**| dyz_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 20**| dnxn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 21**| dnyn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 22**| dnzn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | +| **Pin 1**| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | +| **Pin 2**| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | +| **Pin 3**| model_size |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | +| **Pin 4**| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 5**| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | +| **Pin 6**| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 7**| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 8**| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 9**| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 10**| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 11**| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 12**| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 13**| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 14**| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 15**| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 16**| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 17**| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 18**| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 19**| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 20**| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 21**| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 22**| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/recombine_harmonic_indeces_cyclic.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/recombine_harmonic_indeces_cyclic.md index 464cb1866c..1c25d3ca3c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/recombine_harmonic_indeces_cyclic.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/recombine_harmonic_indeces_cyclic.md @@ -16,23 +16,24 @@ Add the fields corresponding to different load steps with the same frequencies t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| is_constant |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If the result is constant, it will only copy the first result found. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/remove_rigid_body_motion.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/remove_rigid_body_motion.md index 46dbf9a4f0..7a3ec9d058 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/remove_rigid_body_motion.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/remove_rigid_body_motion.md @@ -16,24 +16,24 @@ Removes rigid body mode from a total displacement field by minimization. Use a r | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| reference_node_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Id of the reference entity (node). | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| reference_node_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Id of the reference entity (node). | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 1**| translation_field |[`field`](./../../core-concepts/dpf-types.md#field) | Global rigid translation vector | -| **Pin 2**| rotation_field |[`field`](./../../core-concepts/dpf-types.md#field) | Global rigid rotation angles | -| **Pin 3**| center_field |[`field`](./../../core-concepts/dpf-types.md#field) | Center of the rigid rotation | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 1**| translation_field |[`field`](../../core-concepts/dpf-types.md#field) | Global rigid translation vector | +| **Pin 2**| rotation_field |[`field`](../../core-concepts/dpf-types.md#field) | Global rigid rotation angles | +| **Pin 3**| center_field |[`field`](../../core-concepts/dpf-types.md#field) | Center of the rigid rotation | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/remove_rigid_body_motion_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/remove_rigid_body_motion_fc.md index 45cb3c3c17..3183bae31e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/remove_rigid_body_motion_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/remove_rigid_body_motion_fc.md @@ -16,24 +16,24 @@ Removes rigid body mode from a total displacement field by minimization. Use a r | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| reference_node_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Id of the reference entity (node). | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1| reference_node_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Id of the reference entity (node). | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| translation_field |[`field`](./../../core-concepts/dpf-types.md#field) | Global rigid translation vector | -| **Pin 2**| rotation_field |[`field`](./../../core-concepts/dpf-types.md#field) | Global rigid rotation angles | -| **Pin 3**| center_field |[`field`](./../../core-concepts/dpf-types.md#field) | Center of the rigid rotation | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| translation_field |[`field`](../../core-concepts/dpf-types.md#field) | Global rigid translation vector | +| **Pin 2**| rotation_field |[`field`](../../core-concepts/dpf-types.md#field) | Global rigid rotation angles | +| **Pin 3**| center_field |[`field`](../../core-concepts/dpf-types.md#field) | Center of the rigid rotation | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/result_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/result_provider.md index 317fb00881..01c859c649 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/result_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/result_provider.md @@ -16,13 +16,13 @@ Read/compute user defined result by calling the readers defined by the datasourc | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 60
Required| result_name | | Specifies the scripting name of the raw/internal Name of the result to extract from the file | | Pin 64| result_scripting_name | | Specifies the scripting name of the result to extract;see ResultInfo for details. Use either "result name" or "result scripting name" with their appropriate pin, but not both. | @@ -30,15 +30,15 @@ Read/compute user defined result by calling the readers defined by the datasourc | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation.md index f17079df74..005c3a91b1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation.md @@ -16,20 +16,20 @@ Extracts rigid body motions from a displacement in input. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation_provider.md index 0d3049082c..b49761b101 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation_provider.md @@ -16,20 +16,20 @@ Extracts rigid body transformation from dsub file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams |`stream` | streams (result file container) (optional) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | data source of dsub file. | +| Pin 3| streams |stream | streams (result file container) (optional) | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | data source of dsub file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_static_pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_static_pressure.md index 9673f0c520..826511e51f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_static_pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_static_pressure.md @@ -16,25 +16,25 @@ Read RMS Static Pressure by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_temperature.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_temperature.md index 1bd10063f8..7d2536c06b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_temperature.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_temperature.md @@ -16,25 +16,25 @@ Read RMS Temperature by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_velocity.md index 77f116b817..27a2fe695f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/rms_velocity.md @@ -16,25 +16,25 @@ Read RMS Velocity by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/rom_data_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/rom_data_provider.md index 6807732660..cc06baa107 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/rom_data_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/rom_data_provider.md @@ -16,35 +16,35 @@ Set the required data for the invariant terms computation (reduced matrices, lum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| rom_type |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, customized rom data must be given | -| Pin 1
Required| reduced_stiff_matrix |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced Stiffness matrix | -| Pin 2
Required| reduced_damping_matrix |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced Mass matrix | -| Pin 3
Required| reduced_mass_matrix |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced Damp matrix | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5
Required| reduced_rhs_vector |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced RHS vector | -| Pin 6
Required| lumped_mass_matrix |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped Mass matrix | -| Pin 7
Required| mode_shapes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the customized mode shapes | +| Pin 0
Required| rom_type |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, customized rom data must be given | +| Pin 1
Required| reduced_stiff_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced Stiffness matrix | +| Pin 2
Required| reduced_damping_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced Mass matrix | +| Pin 3
Required| reduced_mass_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced Damp matrix | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 5
Required| reduced_rhs_vector |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced RHS vector | +| Pin 6
Required| lumped_mass_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped Mass matrix | +| Pin 7
Required| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the customized mode shapes | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| rom_matrices |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced matrices | -| **Pin 1**| mode_shapes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | -| **Pin 2**| lumped_mass |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | -| **Pin 3**| model_data |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | -| **Pin 4**| center_of_mass |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | | -| **Pin 5**| inertia_relief |[`field`](./../../core-concepts/dpf-types.md#field) | inertia matrix | -| **Pin 6**| model_size |[`double`](./../../core-concepts/dpf-types.md#standard-types) | size of the model | -| **Pin 7**| field_coordinates_and_euler_angles |[`double`](./../../core-concepts/dpf-types.md#standard-types) | coordinates and euler angles of all nodes | -| **Pin 8**| nod |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | ids of master nodes | -| **Pin 9**| meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | expanded meshed region. | +| **Pin 0**| rom_matrices |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced matrices | +| **Pin 1**| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | +| **Pin 2**| lumped_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | +| **Pin 3**| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | +| **Pin 4**| center_of_mass |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | +| **Pin 5**| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | +| **Pin 6**| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | size of the model | +| **Pin 7**| field_coordinates_and_euler_angles |[`double`](../../core-concepts/dpf-types.md#standard-types) | coordinates and euler angles of all nodes | +| **Pin 8**| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | ids of master nodes | +| **Pin 9**| meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | expanded meshed region. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/smisc.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/smisc.md index 0cea2a0b48..b5d7361eb9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/smisc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/smisc.md @@ -16,33 +16,33 @@ Read/compute elemental summable miscellaneous data by calling the readers define | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 10| item_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | -| Pin 11| num_components |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Number of components for the requested item. | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | +| Pin 11| num_components |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of components for the requested item. | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/specific_heat.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/specific_heat.md index a889b946bb..237896c53a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/specific_heat.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/specific_heat.md @@ -16,25 +16,25 @@ Read Specific Heat by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/spectrum_data.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/spectrum_data.md index 405f2bdce1..3ad7fe82ed 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/spectrum_data.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/spectrum_data.md @@ -16,27 +16,27 @@ Read spectral data from the result files contained in the streams or data source | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| participation_factors |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container holding participation factors. | -| **Pin 1**| mode_coefficients |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container holding mode coefficients (PRS File). | -| **Pin 2**| damping_ratios |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container holding damping ratios (PRS File). | -| **Pin 3**| global_damping |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container holding for each spectrum: Global Damping Ratio, Damping Stiffness Coefficient & Damping Mass Coefficient (PRS File). | -| **Pin 4**| missing_mass |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container holding for each spectrum: Missing Mass Mode (0: None, 1: Active), Missing Mass Effect ZPA (PRS File). | -| **Pin 5**| rigid_response |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container holding for each spectrum: Rigid Response Mode (0: None, 1: Gupta, 2: Lindley), Freq Begin (Gupta) / ZPA (Lindley), Freq End (Gupta) (PRS File). | +| **Pin 0**| participation_factors |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container holding participation factors. | +| **Pin 1**| mode_coefficients |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container holding mode coefficients (PRS File). | +| **Pin 2**| damping_ratios |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container holding damping ratios (PRS File). | +| **Pin 3**| global_damping |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container holding for each spectrum: Global Damping Ratio, Damping Stiffness Coefficient & Damping Mass Coefficient (PRS File). | +| **Pin 4**| missing_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container holding for each spectrum: Missing Mass Mode (0: None, 1: Active), Missing Mass Effect ZPA (PRS File). | +| **Pin 5**| rigid_response |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container holding for each spectrum: Rigid Response Mode (0: None, 1: Gupta, 2: Lindley), Freq Begin (Gupta) / ZPA (Lindley), Freq End (Gupta) (PRS File). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/state_variable.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/state_variable.md index 0c963ac56d..8f01478a66 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/state_variable.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/state_variable.md @@ -10,38 +10,69 @@ license: None ## Description -Read/compute elemental state variable by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute elemental state variable by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 10| item_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/static_pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/static_pressure.md index cb06152bc3..1c3a8f1de1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/static_pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/static_pressure.md @@ -16,25 +16,25 @@ Read Static Pressure by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stiffness_matrix_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stiffness_matrix_energy.md index d474039199..09941f7ee7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stiffness_matrix_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stiffness_matrix_energy.md @@ -16,31 +16,31 @@ Read/compute element energy associated with the stiffness matrix by calling the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/strain_eqv_as_mechanical.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/strain_eqv_as_mechanical.md index 45a0e7f38f..27a116860a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/strain_eqv_as_mechanical.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/strain_eqv_as_mechanical.md @@ -16,28 +16,28 @@ Computes the equivalent (Von Mises) elastic strains and averages it to the nodes | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | -| Pin 13| poisson_ratio |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types) | Poisson ratio to be used in equivalent strain calculation. | -| Pin 14| read_cyclic |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored. | -| Pin 200| average_across_bodies |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | +| Pin 13| poisson_ratio |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | Poisson ratio to be used in equivalent strain calculation. | +| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored. | +| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| meshes_container |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| meshes_container |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/strain_eqv_as_mechanical_workflow.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/strain_eqv_as_mechanical_workflow.md index 73fdb43472..5faf4d983e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/strain_eqv_as_mechanical_workflow.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/strain_eqv_as_mechanical_workflow.md @@ -16,26 +16,26 @@ Generates a workflow that computes the equivalent (Von Mises) elastic strains an | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | -| Pin 14| read_cyclic |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored.. | -| Pin 200| average_across_bodies |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | +| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored.. | +| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | | +| **Pin 0**| workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress.md index 34113d78ca..4cf27198b0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress.md @@ -10,41 +10,72 @@ license: None ## Description -Read/compute element nodal component stresses by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal component stresses by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_X.md index d26a967103..acf4d0161e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_X.md @@ -16,30 +16,30 @@ Read/compute element nodal component stresses XX normal component (00 component) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XY.md index 6f94094ad7..d054e74cbf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XY.md @@ -16,30 +16,30 @@ Read/compute element nodal component stresses XY shear component (01 component) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XZ.md index ce121e361d..f8d1d985de 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XZ.md @@ -16,30 +16,30 @@ Read/compute element nodal component stresses XZ shear component (02 component) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Y.md index f36f4d43ac..ec059e4d28 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Y.md @@ -16,30 +16,30 @@ Read/compute element nodal component stresses YY normal component (11 component) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_YZ.md index fc9730a333..9e3d3f7eec 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_YZ.md @@ -16,30 +16,30 @@ Read/compute element nodal component stresses YZ shear component (12 component) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Z.md index e2d28ff923..2503de5952 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Z.md @@ -16,30 +16,30 @@ Read/compute element nodal component stresses ZZ normal component (22 component) | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_eqv_as_mechanical.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_eqv_as_mechanical.md index 408096c329..0e95d0810e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_eqv_as_mechanical.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_eqv_as_mechanical.md @@ -16,27 +16,27 @@ Computes the equivalent (Von Mises) stresses and averages it to the nodes (by de | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | -| Pin 14| read_cyclic |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored.. | -| Pin 200| average_across_bodies |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | +| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored.. | +| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| meshes_container |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| meshes_container |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_eqv_as_mechanical_workflow.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_eqv_as_mechanical_workflow.md index 60b84fea66..52c8554e6b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_eqv_as_mechanical_workflow.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_eqv_as_mechanical_workflow.md @@ -16,26 +16,26 @@ Generates a workflow that computes the equivalent (Von Mises) stresses and avera | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | -| Pin 14| read_cyclic |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored.. | -| Pin 200| average_across_bodies |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | +| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored.. | +| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | | +| **Pin 0**| workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_intensity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_intensity.md index fbddd7bf3d..0f5e95842a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_intensity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_intensity.md @@ -11,35 +11,36 @@ license: None ## Description Reads/computes element nodal component stresses, average it on nodes (by default) and computes its invariants. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_max_shear.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_max_shear.md index 8f560c57ff..d1c7050387 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_max_shear.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_max_shear.md @@ -11,35 +11,36 @@ license: None ## Description Reads/computes element nodal component stresses, average it on nodes (by default) and computes its invariants. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_1.md index a4375a7e31..b7c6a8baa2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_1.md @@ -11,35 +11,36 @@ license: None ## Description Read/compute element nodal component stresses 1st principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_2.md index 60d1f489ea..52a720cb35 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_2.md @@ -11,35 +11,36 @@ license: None ## Description Read/compute element nodal component stresses 2nd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_3.md index 00b89c6e9f..a6e81710eb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_3.md @@ -11,35 +11,36 @@ license: None ## Description Read/compute element nodal component stresses 3rd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_ratio.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_ratio.md index ab5ab9e1ef..391eefd31a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_ratio.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_ratio.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal stress ratio by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal stress ratio by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md index 9cc656e757..873c4915f3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md @@ -16,21 +16,21 @@ read Euler angles on elements from the result file and rotate the fields in the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream, class dataProcessing::CRstFileWrapper | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_von_mises.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_von_mises.md index 6f6abd812c..b1f0f3252c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_von_mises.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_von_mises.md @@ -11,35 +11,36 @@ license: None ## Description Reads/computes element nodal component stresses, average it on nodes (by default) and computes its invariants. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/structural_temperature.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/structural_temperature.md index 5eb4bc0ad6..9d103c7763 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/structural_temperature.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/structural_temperature.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element structural nodal temperatures by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element structural nodal temperatures by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/superficial_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/superficial_velocity.md index 4e6c6ee61c..833fdf2330 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/superficial_velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/superficial_velocity.md @@ -16,25 +16,25 @@ Read Superficial Velocity by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/surface_heat_rate.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/surface_heat_rate.md index 556676e979..eff380089a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/surface_heat_rate.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/surface_heat_rate.md @@ -16,25 +16,25 @@ Read Surface Heat Rate by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/swelling_strains.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/swelling_strains.md index 885a2dd595..4a58340eb1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/swelling_strains.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/swelling_strains.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal swelling strains by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal swelling strains by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/tangential_contact_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/tangential_contact_force.md index d999c78a36..7a9c01ae2a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/tangential_contact_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/tangential_contact_force.md @@ -16,27 +16,27 @@ Read/compute tangential contact force by calling the readers defined by the data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/tangential_contact_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/tangential_contact_moment.md index 8e1b246bed..546b19482c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/tangential_contact_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/tangential_contact_moment.md @@ -16,27 +16,27 @@ Read/compute tangential contact moment by calling the readers defined by the dat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature.md index 0aa14803b6..a688ef9163 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature.md @@ -16,33 +16,33 @@ Read/compute temperature field by calling the readers defined by the datasources | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad.md index 4e19d385c8..a8f5db55f9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute Temperature Gradient by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute Temperature Gradient by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_X.md index 4ee7253d03..34a2e7b6f3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_X.md @@ -16,30 +16,30 @@ Read/compute Temperature Gradient X component of the vector (1st component) by c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Y.md index 7ce460327d..a28df13816 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Y.md @@ -16,30 +16,30 @@ Read/compute Temperature Gradient Y component of the vector (2nd component) by c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Z.md index 19e3b901e2..d08f7d65bf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Z.md @@ -16,30 +16,30 @@ Read/compute Temperature Gradient Z component of the vector (3rd component) by c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_conductivity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_conductivity.md index 60594ca485..628c4f836d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_conductivity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_conductivity.md @@ -16,25 +16,25 @@ Read Thermal Conductivity by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_dissipation_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_dissipation_energy.md index d59f43a97c..376708d53f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_dissipation_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_dissipation_energy.md @@ -16,27 +16,27 @@ Read/compute thermal dissipation energy by calling the readers defined by the da | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain.md index 55056a2890..c482640230 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal component thermal strains by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal component thermal strains by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_X.md index 0e9ef6dbfc..317d4aaf7f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_X.md @@ -16,30 +16,30 @@ Read/compute element nodal component thermal strains XX normal component (00 com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XY.md index a64ea1ae1d..5b6888bed7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XY.md @@ -16,30 +16,30 @@ Read/compute element nodal component thermal strains XY shear component (01 comp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XZ.md index 79cc2e6487..fc994b1507 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XZ.md @@ -16,30 +16,30 @@ Read/compute element nodal component thermal strains XZ shear component (02 comp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Y.md index e348e41e2e..6fc9e2513c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Y.md @@ -16,30 +16,30 @@ Read/compute element nodal component thermal strains YY normal component (11 com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_YZ.md index ac5ebb22d4..554e1db64c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_YZ.md @@ -16,30 +16,30 @@ Read/compute element nodal component thermal strains YZ shear component (12 comp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Z.md index 8916934447..b42345f1c4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Z.md @@ -16,30 +16,30 @@ Read/compute element nodal component thermal strains ZZ normal component (22 com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_1.md index aed9614c64..495c6ca7d8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_1.md @@ -10,36 +10,37 @@ license: None ## Description -Read/compute element nodal component thermal strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values. +Read/compute element nodal component thermal strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_2.md index 4c347ed1f0..e9b44928bc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_2.md @@ -10,36 +10,37 @@ license: None ## Description -Read/compute element nodal component thermal strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values. +Read/compute element nodal component thermal strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_3.md index c082ca3b97..e3150021ff 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_3.md @@ -10,36 +10,37 @@ license: None ## Description -Read/compute element nodal component thermal strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values. +Read/compute element nodal component thermal strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. +This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strains_eqv.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strains_eqv.md index a6100ac981..a508ab37bd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strains_eqv.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strains_eqv.md @@ -10,37 +10,68 @@ license: None ## Description -Read/compute element nodal equivalent component thermal strains by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. +Read/compute element nodal equivalent component thermal strains by calling the readers defined by the datasources. +- The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. +- Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: + +| Averaging is needed | 'split_shells' | 'shell_layer' | Expected output | +|---------------------|---------------------|---------------|-----------------| +| No | Not connected/false | Not connected | Location as in the result file. Fields with all element shapes combined. All shell layers present. | +| No | true | Not connected | Location as in the result file. Fields split according to element shapes. All shell layers present. | +| No | true | Connected | Location as in the result file. Fields split according to element shapes. Only the requested shell layer present. | +| No | Not connected/false | Connected | Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Not connected | Location as requested. Fields split according to element shapes. All shell layers present. | +| Yes | false | Not connected | Location as requested. Fields with all element shapes combined. All shell layers present. | +| Yes | false | Connected | Location as requested. Fields with all element shapes combined. Only the requested shell layer present. | +| Yes | Not connected/true | Connected | Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +- The available 'elshape' values are: + +| elshape | Related elements | +|---------|------------------| +| 1 | Shell (generic) | +| 2 | Solid | +| 3 | Beam | +| 4 | Skin | +| 5 | Contact | +| 6 | Load | +| 7 | Point | +| 8 | Shell with 1 result across thickness (membrane) | +| 9 | Shell with 2 results across thickness (top/bottom) | +| 10 | Shell with 3 results across thickness (top/bottom/mid) | +| 11 | Gasket | +| 12 | Multi-Point Constraint | +| 13 | Pretension | + ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thickness.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thickness.md index 65faf71ede..5384331fda 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thickness.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thickness.md @@ -16,27 +16,27 @@ Read/compute thickness by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/torque.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/torque.md index 22ced683ec..61b332bdcd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/torque.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/torque.md @@ -16,20 +16,20 @@ Compute torque of a force based on a 3D point. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | -| Pin 1
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | field | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | +| Pin 1
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | field | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_contact_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_contact_force.md index 5471a5f365..bd21503743 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_contact_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_contact_force.md @@ -16,27 +16,27 @@ Read/compute total contact force by calling the readers defined by the datasourc | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_contact_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_contact_moment.md index f68ccf398d..595e81bbe2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_contact_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_contact_moment.md @@ -16,27 +16,27 @@ Read/compute total contact moment by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_mass.md index 4a33cd0d4d..afcfd83a8e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_mass.md @@ -16,19 +16,19 @@ Reads total mass from mode file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data sources (must contain at least one mode file). | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources (must contain at least one mode file). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mass |[`double`](./../../core-concepts/dpf-types.md#standard-types) | the unit should be grabbed from the rst file | +| **Pin 0**| mass |[`double`](../../core-concepts/dpf-types.md#standard-types) | the unit should be grabbed from the rst file | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_pressure.md index 4abf02d6c2..5549f73c22 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_pressure.md @@ -16,25 +16,25 @@ Read Total Pressure by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_strain.md index e4f54602a0..2c89621486 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_strain.md @@ -16,27 +16,27 @@ Read/compute Total strain (LSDyna) by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_temperature.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_temperature.md index f6854bc517..556c753bfe 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/total_temperature.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/total_temperature.md @@ -16,25 +16,25 @@ Read Total Temperature by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/transform_invariant_terms_rbd.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/transform_invariant_terms_rbd.md index 163a252b43..cda2b6ebac 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/transform_invariant_terms_rbd.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/transform_invariant_terms_rbd.md @@ -16,66 +16,66 @@ Transform invariant terms rbd based on a coordinate system (translation + rotati | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| rotation_matrix |[`field`](./../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix. | -| Pin 1
Required| coordinate_system |[`field`](./../../core-concepts/dpf-types.md#field) | origin of the new coordinate system. | -| Pin 2
Required| model_data |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | -| Pin 3
Required| center_of_mass |[`field`](./../../core-concepts/dpf-types.md#field) | center of mass of the body | -| Pin 4
Required| inertia_relief |[`field`](./../../core-concepts/dpf-types.md#field) | inertia matrix | -| Pin 5
Required| model_size |[`double`](./../../core-concepts/dpf-types.md#standard-types) | size of the diagonal box containing the body | -| Pin 6
Required| master_node_coordinates |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 7
Required| v_trsf |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | -| Pin 8
Required| k_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 9
Required| mass_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 10
Required| c_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 11
Required| rhs |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 12
Required| dn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 13
Required| dr_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14
Required| drn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 15
Required| dn_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 16
Required| dnx_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 17
Required| dny_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 18
Required| dnz_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 19
Required| dyx_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 20
Required| dyy_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 21
Required| dyz_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 22
Required| dnxn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 23
Required| dnyn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 24
Required| dnzn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| rotation_matrix |[`field`](../../core-concepts/dpf-types.md#field) | 3-3 rotation matrix. | +| Pin 1
Required| coordinate_system |[`field`](../../core-concepts/dpf-types.md#field) | origin of the new coordinate system. | +| Pin 2
Required| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | +| Pin 3
Required| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | +| Pin 4
Required| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | +| Pin 5
Required| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | size of the diagonal box containing the body | +| Pin 6
Required| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 7
Required| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | +| Pin 8
Required| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 9
Required| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 10
Required| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 11
Required| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 12
Required| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 13
Required| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14
Required| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 15
Required| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 16
Required| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 17
Required| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 18
Required| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 19
Required| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 20
Required| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 21
Required| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 22
Required| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 23
Required| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 24
Required| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| model_data |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | -| **Pin 1**| center_of_mass |[`field`](./../../core-concepts/dpf-types.md#field) | center of mass of the body | -| **Pin 2**| inertia_relief |[`field`](./../../core-concepts/dpf-types.md#field) | inertia matrix | -| **Pin 3**| model_size |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | | -| **Pin 4**| master_node_coordinates |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 5**| v_trsf |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | -| **Pin 6**| k_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 7**| mass_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 8**| c_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 9**| rhs |[`field`](./../../core-concepts/dpf-types.md#field) | | -| **Pin 10**| dn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 11**| dr_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 12**| drn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 13**| dn_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 14**| dnx_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 15**| dny_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 16**| dnz_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 17**| dyx_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 18**| dyy_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 19**| dyz_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 20**| dnxn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 21**| dnyn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| **Pin 22**| dnzn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | +| **Pin 1**| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | +| **Pin 2**| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | +| **Pin 3**| model_size |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | +| **Pin 4**| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 5**| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | +| **Pin 6**| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 7**| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 8**| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 9**| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | +| **Pin 10**| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 11**| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 12**| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 13**| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 14**| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 15**| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 16**| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 17**| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 18**| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 19**| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 20**| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 21**| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 22**| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/transient_rayleigh_integration.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/transient_rayleigh_integration.md index af4f789b0b..527e4ee6e5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/transient_rayleigh_integration.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/transient_rayleigh_integration.md @@ -16,25 +16,25 @@ Computes the transient Rayleigh integral | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | the input field container expects acceleration fields | -| Pin 1
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | The meshes region in this pin has to be boundary or skin mesh. This is the source meshes. | -| Pin 2
Required| time_scoping |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | Load step number (if it's specified, the Transient rayleigh integration is computed only on the substeps of this step) or time scoping | -| Pin 3
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | The field represents the coordinates of the observation position. It should be specified if not observation mesh is provided. | -| Pin 4
Required| observation_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | This is the observation mesh region | -| Pin 5
Required| mass_density |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Mass density (if it's not specified, default value of the air is applied). | -| Pin 6
Required| speed_of_sound |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | the input field container expects acceleration fields | +| Pin 1
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The meshes region in this pin has to be boundary or skin mesh. This is the source meshes. | +| Pin 2
Required| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Load step number (if it's specified, the Transient rayleigh integration is computed only on the substeps of this step) or time scoping | +| Pin 3
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | The field represents the coordinates of the observation position. It should be specified if not observation mesh is provided. | +| Pin 4
Required| observation_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | This is the observation mesh region | +| Pin 5
Required| mass_density |[`double`](../../core-concepts/dpf-types.md#standard-types) | Mass density (if it's not specified, default value of the air is applied). | +| Pin 6
Required| speed_of_sound |[`double`](../../core-concepts/dpf-types.md#standard-types) | Speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/turbulent_kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/turbulent_kinetic_energy.md index 04887ed6aa..ac4f6064a0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/turbulent_kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/turbulent_kinetic_energy.md @@ -16,25 +16,25 @@ Read Turbulent Kinetic Energy (k) by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/turbulent_viscosity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/turbulent_viscosity.md index 9d7236f7a9..2a5ef98298 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/turbulent_viscosity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/turbulent_viscosity.md @@ -16,25 +16,25 @@ Read Turbulent Viscosity by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity.md index 79fd4ad8ee..d319715bd5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity.md @@ -16,33 +16,33 @@ Read/compute nodal velocities by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](./../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_X.md index 250f227cad..00959ce4ac 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_X.md @@ -16,28 +16,28 @@ Read/compute nodal velocities X component of the vector (1st component) by calli | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Y.md index 74d0f616d8..d7ca498dfb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Y.md @@ -16,28 +16,28 @@ Read/compute nodal velocities Y component of the vector (2nd component) by calli | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Z.md index ff6c4c2662..b388380794 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Z.md @@ -16,28 +16,28 @@ Read/compute nodal velocities Z component of the vector (3rd component) by calli | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 2| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](./../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/volume_fraction.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/volume_fraction.md index a07d220d1e..426820aa4e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/volume_fraction.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/volume_fraction.md @@ -16,25 +16,25 @@ Read Volume Fraction by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/wall_shear_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/wall_shear_stress.md index 16b3796e3d..1ac22fdbc1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/wall_shear_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/wall_shear_stress.md @@ -16,25 +16,25 @@ Read Wall Shear Stress by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_component.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_component.md index 1b4689439d..9740eed737 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_component.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_component.md @@ -16,30 +16,31 @@ Calculates the cumulated energy per component (Named Selection). For cyclic and | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | When the input is a scoping, it is treated as the master scoping. All named selections will intersect with it. When the input is a scopings container, named selections will not be needed. | -| Pin 2| energy_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain energy, 2: Kinetic energy, 3: All energy types) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5| named_selection |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Named Selections. Intersection of all Named Selections with the master scoping will be done. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | When the input is a scoping, it is treated as the master scoping. All named selections will intersect with it. When the input is a scopings container, named selections will not be needed. | +| Pin 2| energy_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain energy, 2: Kinetic energy, 3: All energy types) | +| Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 5| named_selection |[`string`](../../core-concepts/dpf-types.md#standard-types) | Named Selections. Intersection of all Named Selections with the master scoping will be done. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| component_energy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| component_energy_percentage |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 2**| component_total_energy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 3**| component_total_energy_percentage |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 4**| component_strain_energy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 5**| component_strain_energy_percentage |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 6**| component_kinetic_energy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 7**| component_kinetic_energy_percentage |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| component_energy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| component_energy_percentage |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 2**| component_total_energy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 3**| component_total_energy_percentage |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 4**| component_strain_energy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 5**| component_strain_energy_percentage |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 6**| component_kinetic_energy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 7**| component_kinetic_energy_percentage |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_harmonic.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_harmonic.md index c0586ade97..f979c2eb1c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_harmonic.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_harmonic.md @@ -16,23 +16,24 @@ Calculates the cumulated energy per harmonic in a multistage multiharmonic model | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Master scoping. All harmonics will be intersected with this scoping. | -| Pin 2| energy_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain energy, 2: Kinetic energy) | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Master scoping. All harmonics will be intersected with this scoping. | +| Pin 2| energy_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain energy, 2: Kinetic energy) | +| Pin 3
Required| stream |stream | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| harmonic_energy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| harmonic_energy_percentage |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| harmonic_energy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| harmonic_energy_percentage |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/write_cms_rbd_file.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/write_cms_rbd_file.md index f9056f1174..a474a6e999 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/write_cms_rbd_file.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/write_cms_rbd_file.md @@ -16,42 +16,42 @@ Write the invariant terms and the model data in a cms_rbd file | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| model_data |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | -| Pin 1
Required| center_of_mass |[`field`](./../../core-concepts/dpf-types.md#field) | center of mass of the body | -| Pin 2
Required| inertia_relief |[`field`](./../../core-concepts/dpf-types.md#field) | inertia matrix | -| Pin 3
Required| model_size |[`double`](./../../core-concepts/dpf-types.md#standard-types) | size of the diagonal box containing the body | -| Pin 4
Required| master_node_coordinates |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 5
Required| v_trsf |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | -| Pin 6
Required| k_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 7
Required| mass_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 8
Required| c_mat |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 9
Required| rhs |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 10
Required| dn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 11
Required| dr_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 12
Required| drn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 13
Required| dn_cross_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14
Required| dnx_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 15
Required| dny_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 16
Required| dnz_y |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 17
Required| dyx_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 18
Required| dyy_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 19
Required| dyz_n |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 20
Required| dnxn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 21
Required| dnyn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 22
Required| dnzn |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 23
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | path with cms_rbd extension where the export occurs | +| Pin 0
Required| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | +| Pin 1
Required| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | +| Pin 2
Required| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | +| Pin 3
Required| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | size of the diagonal box containing the body | +| Pin 4
Required| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5
Required| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | +| Pin 6
Required| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 7
Required| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 8
Required| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 9
Required| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 10
Required| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 11
Required| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 12
Required| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 13
Required| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14
Required| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 15
Required| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 16
Required| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 17
Required| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 18
Required| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 19
Required| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 20
Required| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 21
Required| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 22
Required| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 23
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | path with cms_rbd extension where the export occurs | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data Source containing the cms_rbd file generated. | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data Source containing the cms_rbd file generated. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/write_motion_dfmf_file.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/write_motion_dfmf_file.md index 3bf9dcf899..02ed8e1127 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/write_motion_dfmf_file.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/write_motion_dfmf_file.md @@ -16,37 +16,37 @@ Write the invariant terms and the model data in a motion dfmf file | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| model_data |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | -| Pin 1
Required| mode_shapes |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | -| Pin 2
Required| lumped_mass |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | -| Pin 3
Required| field_coordinates |[`field`](./../../core-concepts/dpf-types.md#field) | coordinates of all nodes | -| Pin 4
Required| nod |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 5
Required| used_node_index |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 6
Required| eigenvalue |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 7
Required| translational_mode_shape |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 8
Required| rotational_mode_shape |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 9
Required| invrt_1 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 10
Required| invrt_2 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 11
Required| invrt_3 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 12
Required| invrt_4 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 13
Required| invrt_5 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14
Required| invrt_6 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 15
Required| invrt_7 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 16
Required| invrt_8 |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 17
Required| dfmffile_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | path with motion dfmf extension where the export occurs | -| Pin 18
Required| rstfile_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | +| Pin 1
Required| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | +| Pin 2
Required| lumped_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | +| Pin 3
Required| field_coordinates |[`field`](../../core-concepts/dpf-types.md#field) | coordinates of all nodes | +| Pin 4
Required| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5
Required| used_node_index |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 6
Required| eigenvalue |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 7
Required| translational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 8
Required| rotational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 9
Required| invrt_1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 10
Required| invrt_2 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 11
Required| invrt_3 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 12
Required| invrt_4 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 13
Required| invrt_5 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14
Required| invrt_6 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 15
Required| invrt_7 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 16
Required| invrt_8 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 17
Required| dfmffile_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | path with motion dfmf extension where the export occurs | +| Pin 18
Required| rstfile_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| dfmf_data_source |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Data Source containing the dfmf file generated. | +| **Pin 0**| dfmf_data_source |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data Source containing the dfmf file generated. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/y_plus.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/y_plus.md index cc8e879164..ab789edca3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/y_plus.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/y_plus.md @@ -16,25 +16,25 @@ Read Y Plus (y+) by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. | -| Pin 1| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | -| Pin 1000| qualifiers |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/adapt_with_scopings_container.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/adapt_with_scopings_container.md index b35bb741d6..448b202435 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/adapt_with_scopings_container.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/adapt_with_scopings_container.md @@ -16,22 +16,23 @@ Rescopes/splits a fields container to correspond to a scopings container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| scopings_container |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | | +| Pin 0
Required| field_or_fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| scopings_container |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | +| Pin 2| keep_empty_fields |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default false. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/change_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/change_fc.md index 1a7dbafdff..077f46a601 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/change_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/change_fc.md @@ -16,22 +16,22 @@ DEPRECATED, PLEASE USE ADAPT WITH SCOPINGS CONTAINER. Rescopes/splits a fields c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| scopings_container |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | | +| Pin 0
Required| field_or_fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| scopings_container |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/compute_element_centroids.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/compute_element_centroids.md index f49607ace6..22291525a3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/compute_element_centroids.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/compute_element_centroids.md @@ -16,22 +16,22 @@ Computes the element centroids of the mesh. It also outputs the element measure. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| element_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | If provided, only the centroids of the elements in the scoping are computed. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh to compute centroids | +| Pin 1| element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | If provided, only the centroids of the elements in the scoping are computed. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh to compute centroids | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| centroids |[`field`](./../../core-concepts/dpf-types.md#field) | element centroids. | -| **Pin 1**| measure |[`field`](./../../core-concepts/dpf-types.md#field) | element measure (length, surface or volume depending on the dimension of the element). | +| **Pin 0**| centroids |[`field`](../../core-concepts/dpf-types.md#field) | element centroids. | +| **Pin 1**| measure |[`field`](../../core-concepts/dpf-types.md#field) | element measure (length, surface or volume depending on the dimension of the element). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/connectivity_ids.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/connectivity_ids.md index 4af67b4063..57c38bd4ce 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/connectivity_ids.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/connectivity_ids.md @@ -16,22 +16,22 @@ Returns the ordered node ids corresponding to the element ids scoping in input. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1
Required| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Elemental scoping | -| Pin 7| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | the support of the scoping is expected if there is no mesh in input | -| Pin 10| take_mid_nodes |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | default is true | +| Pin 1
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental scoping | +| Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | the support of the scoping is expected if there is no mesh in input | +| Pin 10| take_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is true | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| **Pin 1**| elemental_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | same as the input scoping but with ids duplicated to have the same size as nodal output scoping | +| **Pin 0**| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| **Pin 1**| elemental_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | same as the input scoping but with ids duplicated to have the same size as nodal output scoping | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/elemental_from_mesh.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/elemental_from_mesh.md index 98a16bc7c0..d30cbfa294 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/elemental_from_mesh.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/elemental_from_mesh.md @@ -16,19 +16,19 @@ Retrieves the elemental scoping of a given input mesh, which contains the elemen | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/from_mesh.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/from_mesh.md index 05e92dc01e..8936e70f97 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/from_mesh.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/from_mesh.md @@ -16,20 +16,20 @@ Provides the entire mesh scoping based on the requested location | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | if nothing the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | if nothing the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/intersect.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/intersect.md index 9f1b6fbfa4..4c52d0ce9a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/intersect.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/intersect.md @@ -16,21 +16,21 @@ Intersect 2 scopings and return the intersection and the difference between the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| scopingA |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1
Required| scopingB |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| Pin 0
Required| scopingA |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1
Required| scopingB |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| intersection |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| **Pin 1**| scopingA_min_intersection |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| intersection |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| **Pin 1**| scopingA_min_intersection |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/nodal_from_mesh.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/nodal_from_mesh.md index fe12df2c84..747e918cee 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/nodal_from_mesh.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/nodal_from_mesh.md @@ -16,19 +16,19 @@ Retrieves the nodal scoping of a given input mesh, which contains the node IDs. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_mesh_property.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_mesh_property.md index 212f650a3b..ae436ce959 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_mesh_property.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_mesh_property.md @@ -16,23 +16,23 @@ Provides a scoping on a given property name and a property number. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Nodal or Elemental location are expected | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | ex "apdl_element_type", "elprops", "mat", "eltype", "connectivity", "shell_elements", "solid_elements", "skin_elements", "beam_elements", "point_elements"... | -| Pin 2| property_id |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 5| inclusive |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Default is 1 (inclusive is true). Only used if 'shape_values' property is requested. If inclusive is set to 1 and 'elprops' property field is available, it will select all elements that are set on the corresponding property. If inclusive is set to 0 (exclusive) and 'elprops' property field is available, it will select the elements that are only set on this property. | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Nodal or Elemental location are expected | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | ex "apdl_element_type", "elprops", "mat", "eltype", "connectivity", "shell_elements", "solid_elements", "skin_elements", "beam_elements", "point_elements"... | +| Pin 2| property_id |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Default is 1 (inclusive is true). Only used if 'shape_values' property is requested. If inclusive is set to 1 and 'elprops' property field is available, it will select all elements that are set on the corresponding property. If inclusive is set to 0 (exclusive) and 'elprops' property field is available, it will select the elements that are only set on this property. | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Scoping | +| **Pin 0**| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_named_selection.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_named_selection.md index 296e1ada8c..a2121a196d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_named_selection.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_named_selection.md @@ -16,23 +16,23 @@ provides a scoping at a given location based on a given named selection | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1
Required| named_selection_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | the string is expected to be in upper case | -| Pin 2| int_inclusive |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If element scoping is requested on a nodal named selection, if Inclusive == 1 then add all the elements adjacent to the nodes.If Inclusive == 0, only the elements which have all their nodes in the named selection are included | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| named_selection_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | the string is expected to be in upper case | +| Pin 2| int_inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If element scoping is requested on a nodal named selection, if Inclusive == 1 then add all the elements adjacent to the nodes.If Inclusive == 0, only the elements which have all their nodes in the named selection are included | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_property.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_property.md index 046a08fcc1..8e2f921b0a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_property.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/on_property.md @@ -16,24 +16,24 @@ Provides a scoping at a given location based on a given property name and a prop | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Nodal or Elemental location are expected | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | ex "mapdl_element_type", "mapdl_element_type_id", "apdl_type_index", "mapdl_type_id", "material", "apdl_section_id", "apdl_real_id", "apdl_esys_id", "shell_axi", "volume_axi"... | -| Pin 2
Required| property_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5| inclusive |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | If element scoping is requested on a nodal named selection, if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | +| Pin 0
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Nodal or Elemental location are expected | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | ex "mapdl_element_type", "mapdl_element_type_id", "apdl_type_index", "mapdl_type_id", "material", "apdl_section_id", "apdl_real_id", "apdl_esys_id", "shell_axi", "volume_axi"... | +| Pin 2
Required| property_id |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | property_id or vector of property ids | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 5| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If element scoping is requested on a nodal named selection, if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Scoping | +| **Pin 0**| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/reduce_sampling.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/reduce_sampling.md index 274efc3314..6fa50b1777 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/reduce_sampling.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/reduce_sampling.md @@ -16,20 +16,20 @@ Take a scoping and remove half of it's content. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1| denominator |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Set the number of time the scoping is reduced (default is 2). Must be integer value above 1. | +| Pin 0
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1| denominator |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Set the number of time the scoping is reduced (default is 2). Must be integer value above 1. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope.md index 54a48784b4..bbdee1ea98 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope.md @@ -16,23 +16,23 @@ Rescopes a field on the given scoping. If an ID does not exist in the original f | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2| default_value |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | If pin 2 is used, the IDs not found in the field are added with this default value. | +| Pin 0
Required| fields |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | If pin 2 is used, the IDs not found in the field are added with this default value. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| fields |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_custom_type_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_custom_type_field.md index 3d5530dcf6..a71b3063db 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_custom_type_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_custom_type_field.md @@ -16,23 +16,23 @@ Rescopes a custom type field on the given scoping. If an ID does not exist in th | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields |[`custom_type_fields_container`](./../../core-concepts/dpf-types.md#custom-type-fields-container), [`custom_type_field`](./../../core-concepts/dpf-types.md#custom-type-field) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2| default_value |[`custom_type_field`](./../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_field`](./../../core-concepts/dpf-types.md#custom-type-field) | If pin 2 is used, the IDs not found in the custom type field are added with this default value. | +| Pin 0
Required| fields |[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| default_value |[`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | If pin 2 is used, the IDs not found in the custom type field are added with this default value. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields |[`custom_type_fields_container`](./../../core-concepts/dpf-types.md#custom-type-fields-container), [`custom_type_field`](./../../core-concepts/dpf-types.md#custom-type-field) | | +| **Pin 0**| fields |[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_fc.md index 2da83b635c..57705de8c9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_fc.md @@ -16,23 +16,23 @@ Rescopes a field on the given scoping. If an ID does not exist in the original f | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2| default_value |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | If pin 2 is used, the IDs not found in the field are added with this default value. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | If pin 2 is used, the IDs not found in the field are added with this default value. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_property_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_property_field.md index 0eda06d5fa..80f5da858c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_property_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/rescope_property_field.md @@ -16,23 +16,23 @@ Rescopes a property field on the given scoping. If an ID does not exist in the o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields |[`property_fields_container`](./../../core-concepts/dpf-types.md#property-fields-container), [`property_field`](./../../core-concepts/dpf-types.md#property-field) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2| default_value |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | If pin 2 is used, the IDs not found in the property field are added with this default value. | +| Pin 0
Required| fields |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| default_value |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | If pin 2 is used, the IDs not found in the property field are added with this default value. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields |[`property_fields_container`](./../../core-concepts/dpf-types.md#property-fields-container), [`property_field`](./../../core-concepts/dpf-types.md#property-field) | | +| **Pin 0**| fields |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/scoping_get_attribute.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/scoping_get_attribute.md index b0d5410cee..4255b09ed6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/scoping_get_attribute.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/scoping_get_attribute.md @@ -16,20 +16,20 @@ Uses the Scoping APIs to return a given attribute of the scoping in input. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "ids", "location". | +| Pin 0
Required| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "ids", "location". | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`string`](./../../core-concepts/dpf-types.md#standard-types) | Returns a vector of int for property: "ids" and a string for property: "location". | +| **Pin 0**| property |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Returns a vector of int for property: "ids" and a string for property: "location". | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/split_on_property_type.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/split_on_property_type.md index 8542210895..13815c7f72 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/split_on_property_type.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/split_on_property_type.md @@ -16,23 +16,23 @@ Splits a given scoping or the mesh scoping (nodal or elemental) on given propert | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Scoping | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | mesh region | -| Pin 9
Required| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | location (default is elemental) | -| Pin 12| skin_case |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | set to 0: to have skin elements in their own group, 1: merge skin and solid elements, 2: merge skin and shell elements (default) | -| Pin 13| label |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | properties to apply the filtering 'mat' and/or 'elshape' (since 2025R1 it supports any property name contained in the mesh property fields) (default is 'elshape') | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh region | +| Pin 9
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | location (default is elemental) | +| Pin 12| skin_case |[`int32`](../../core-concepts/dpf-types.md#standard-types) | set to 0: to have skin elements in their own group, 1: merge skin and solid elements, 2: merge skin and shell elements (default) | +| Pin 13| label |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | properties to apply the filtering 'mat' and/or 'elshape' (since 2025R1 it supports any property name contained in the mesh property fields) (default is 'elshape') | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Scoping | +| **Pin 0**| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Scoping | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/transpose.md b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/transpose.md index 1433319ece..ef7e14d46f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/scoping/transpose.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/scoping/transpose.md @@ -16,22 +16,22 @@ Transposes the input scoping or scopings container (Elemental/Faces --> Nodal, o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Scoping or scopings container (the input type is the output type) | -| Pin 1
Required| meshed_region |[`meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 2| inclusive |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | -| Pin 9| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Output scoping location for meshes with nodes, faces and elements. By default, elemental and faces scopings transpose to nodal, and nodal scopings transpose to elemental. | +| Pin 0
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Scoping or scopings container (the input type is the output type) | +| Pin 1
Required| meshed_region |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 2| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Output scoping location for meshes with nodes, faces and elements. By default, elemental and faces scopings transpose to nodal, and nodal scopings transpose to elemental. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Scoping or scopings container (the input type is the output type) | +| **Pin 0**| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Scoping or scopings container (the input type is the output type) | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/csv_to_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/csv_to_field.md index 00be9946c3..3e72eff36f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/csv_to_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/csv_to_field.md @@ -16,20 +16,20 @@ transform csv file to a field or fields container | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | data sources containing a file with csv extension | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | data sources containing a file with csv extension | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/data_tree_to_json.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/data_tree_to_json.md index 06d10a9138..3ccb5bff20 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/data_tree_to_json.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/data_tree_to_json.md @@ -16,20 +16,20 @@ Writes a json file or string from a DataTree | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| data_tree |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | | -| Pin 1| path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| data_tree |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | | +| Pin 1| path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources), [`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/data_tree_to_txt.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/data_tree_to_txt.md index fcfd15a04a..388620cd92 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/data_tree_to_txt.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/data_tree_to_txt.md @@ -16,20 +16,20 @@ Writes a txt file or string from a DataTree | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| data_tree |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | | -| Pin 1| path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| data_tree |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | | +| Pin 1| path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources), [`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/deserializer.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/deserializer.md index 7a2b5ca982..2ed81afeba 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/deserializer.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/deserializer.md @@ -16,20 +16,20 @@ Takes a file generated by the serializer and deserializes it into DPF's entities | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| stream_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 for ASCII (default), and 1 for binary | -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | file path | +| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 for ASCII (default), and 1 for binary | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | file path | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 1**| any_output |[`any`](./../../core-concepts/dpf-types.md#any) | number and types of outputs corresponding of the inputs used in the serialization | +| **Pin 1**| any_output |[`any`](../../core-concepts/dpf-types.md#any) | number and types of outputs corresponding of the inputs used in the serialization | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/export_mesh_with_prime.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/export_mesh_with_prime.md index 717dd23b7e..3888d8e371 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/export_mesh_with_prime.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/export_mesh_with_prime.md @@ -16,8 +16,8 @@ Transfer DPF's meshed region into an external layer prime model and serialize it | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | path(with the file extension) to export | -| Pin 7
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 0
Required| path |[`string`](../../core-concepts/dpf-types.md#standard-types) | path(with the file extension) to export | +| Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs @@ -28,7 +28,7 @@ Transfer DPF's meshed region into an external layer prime model and serialize it | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/export_symbolic_workflow.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/export_symbolic_workflow.md index 0a0d1edaea..b5d68da3f3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/export_symbolic_workflow.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/export_symbolic_workflow.md @@ -16,22 +16,22 @@ Transforms a Workflow into a symbolic Workflow and writes it to a file (if a pat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | | -| Pin 1| path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2| format |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 is ASCII format and 1 is binary, default is 0. | -| Pin 3| options |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1 copies connections with its data, 2 forwards named inputs and outputs names, 7 copies connections of named inputs and ouputs with their data. default is 7. | +| Pin 0
Required| workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | +| Pin 1| path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| format |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 is ASCII format and 1 is binary, default is 0. | +| Pin 3| options |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 copies connections with its data, 2 forwards named inputs and outputs names, 7 copies connections of named inputs and ouputs with their data. default is 7. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources), [`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/field_to_csv.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/field_to_csv.md index 0a69dfecca..4e4840c09c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/field_to_csv.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/field_to_csv.md @@ -16,9 +16,9 @@ Exports a field or a fields container into a csv file | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | field_or_fields_container | -| Pin 1
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2| storage_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | storage type : if matrices (without any particularity) are included in the fields container, the storage format can be chosen. 0 : flat/line format, 1 : ranked format. If 1 is chosen, the csv can not be read by "csv to field" operator anymore. Default : 0. | +| Pin 0
Required| field_or_fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | field_or_fields_container | +| Pin 1
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| storage_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | storage type : if matrices (without any particularity) are included in the fields container, the storage format can be chosen. 0 : flat/line format, 1 : ranked format. If 1 is chosen, the csv can not be read by "csv to field" operator anymore. Default : 0. | ## Outputs @@ -29,7 +29,7 @@ Exports a field or a fields container into a csv file | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/hdf5dpf_custom_read.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/hdf5dpf_custom_read.md index a8ed54ace4..79762a7002 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/hdf5dpf_custom_read.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/hdf5dpf_custom_read.md @@ -16,24 +16,24 @@ Extract a custom result from an hdf5dpf file. This operator is deprecated, pleas | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Hdf5df file stream. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Hdf5df file data source. | -| Pin 24| meta_data |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | meta_data that may be used to evaluate results or extract workflows. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Hdf5df file stream. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Hdf5df file data source. | +| Pin 24| meta_data |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | meta_data that may be used to evaluate results or extract workflows. | | Pin 60
Required| result_name | | Name of the result that must be extracted from the hdf5dpf file | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_or_fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field_or_fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/hdf5dpf_generate_result_file.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/hdf5dpf_generate_result_file.md index ee5d1403b8..44632bdb1e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/hdf5dpf_generate_result_file.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/hdf5dpf_generate_result_file.md @@ -16,28 +16,28 @@ Generate a dpf result file from provided information. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -6| append_mode |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Experimental: Allow appending chunked data to the file. This disables fields container content deduplication. | -| Pin -5| dataset_size_compression_threshold |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 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`](./../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](./../../core-concepts/dpf-types.md#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`](./../../core-concepts/dpf-types.md#standard-types) | converts double to float to reduce file size (default is true) | -| Pin 0
Required| filename |[`string`](./../../core-concepts/dpf-types.md#standard-types) | name of the output file that will be generated (utf8). | -| Pin 1| mesh_provider_out |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | defines the MeshedRegion that is exported and provided by MeshProvider. | -| Pin 2| time_freq_support_out |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | defines the TimeFreqSupport that is exported and provided by TimeFreqSupportProvider. | -| Pin 3| ansys_unit_system_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`result_info`](./../../core-concepts/dpf-types.md#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`](./../../core-concepts/dpf-types.md#standard-types), [`any`](./../../core-concepts/dpf-types.md#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. | +| Pin -6| append_mode |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Experimental: Allow appending chunked data to the file. This disables fields container content deduplication. | +| Pin -5| dataset_size_compression_threshold |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 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`](../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](../../core-concepts/dpf-types.md#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`](../../core-concepts/dpf-types.md#standard-types) | converts double to float to reduce file size (default is true) | +| Pin 0
Required| filename |[`string`](../../core-concepts/dpf-types.md#standard-types) | name of the output file that will be generated (utf8). | +| Pin 1| mesh_provider_out |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | defines the MeshedRegion that is exported and provided by MeshProvider. | +| Pin 2| time_freq_support_out |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | defines the TimeFreqSupport that is exported and provided by TimeFreqSupportProvider. | +| Pin 3| ansys_unit_system_id |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`result_info`](../../core-concepts/dpf-types.md#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`](../../core-concepts/dpf-types.md#standard-types), [`any`](../../core-concepts/dpf-types.md#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`](./../../core-concepts/dpf-types.md#data-sources) | data_sources filled with the H5 generated file path. | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | data_sources filled with the H5 generated file path. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **evaluate_inputs_before_run** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | 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`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **evaluate_inputs_before_run** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | 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`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/import_symbolic_workflow.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/import_symbolic_workflow.md index a5c54e94c0..6bc6c7d0d9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/import_symbolic_workflow.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/import_symbolic_workflow.md @@ -16,20 +16,20 @@ Reads a file or string holding a Symbolic Workflow and instantiate a WorkFlow wi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| string_or_path |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 2| format |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | -1 is auto-detection, 0 is ASCII format, 1 is binary, 2 is json, default is -1 (auto-detection). | +| Pin 0
Required| string_or_path |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 2| format |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -1 is auto-detection, 0 is ASCII format, 1 is binary, 2 is json, default is -1 (auto-detection). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | | +| **Pin 0**| workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/json_to_data_tree.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/json_to_data_tree.md index 78ab1a2941..da1aa5a392 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/json_to_data_tree.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/json_to_data_tree.md @@ -16,19 +16,19 @@ Reads a json file or string to a DataTree | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| string_or_path |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0
Required| string_or_path |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_tree |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | | +| **Pin 0**| data_tree |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/mechanical_csv_to_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/mechanical_csv_to_field.md index d62351407b..05b95ee5ff 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/mechanical_csv_to_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/mechanical_csv_to_field.md @@ -16,22 +16,22 @@ Reads mechanical exported csv file | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| unit |`class dataProcessing::unit::CUnit` | | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 9
Required| requested_location |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`field_definition`](./../../core-concepts/dpf-types.md#field-definition) | | +| Pin 0
Required| unit |class dataProcessing::unit::CUnit | | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 9
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types), [`field_definition`](../../core-concepts/dpf-types.md#field-definition) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/migrate_file_to_vtk.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/migrate_file_to_vtk.md index 940e9bba4c..f87f458e70 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/migrate_file_to_vtk.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/migrate_file_to_vtk.md @@ -16,21 +16,21 @@ Take an input data sources or streams and convert as much data as possible to vt | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| output_filename |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0| output_filename |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Generated output vtk file | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Generated output vtk file | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/migrate_to_vtu.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/migrate_to_vtu.md index 4d2e89656c..e10e760743 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/migrate_to_vtu.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/migrate_to_vtu.md @@ -16,26 +16,26 @@ Extract all results from a datasources and exports them into vtu format. All the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | time sets to export, default is all | -| Pin 3| streams_container |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 20
Required| directory |[`string`](./../../core-concepts/dpf-types.md#standard-types) | directory path | -| Pin 21| base_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | vtu base file name, (default is file) | -| Pin 30| result |[`string`](./../../core-concepts/dpf-types.md#standard-types) | if Operator's names are connected to this Pin, only these results are exported (else all available results are exported) | -| Pin 100| write_mode |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Available are rawbinarycompressed, rawbinary, base64appended, base64inline, ascii, default is (rawbinarycompressed) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time sets to export, default is all | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | +| Pin 20
Required| directory |[`string`](../../core-concepts/dpf-types.md#standard-types) | directory path | +| Pin 21| base_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | vtu base file name, (default is file) | +| Pin 30| result |[`string`](../../core-concepts/dpf-types.md#standard-types) | if Operator's names are connected to this Pin, only these results are exported (else all available results are exported) | +| Pin 100| write_mode |[`string`](../../core-concepts/dpf-types.md#standard-types) | Available are rawbinarycompressed, rawbinary, base64appended, base64inline, ascii, default is (rawbinarycompressed) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| path |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | list of output vtu file path | +| **Pin 0**| path |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | list of output vtu file path | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serialize_to_hdf5.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serialize_to_hdf5.md index 4d29c4d376..e519a790b1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serialize_to_hdf5.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serialize_to_hdf5.md @@ -16,9 +16,9 @@ This operator is deprecated: use 'hdf5::h5dpf::make_result_file' instead. Serial | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | output file path with .h5 extension | -| Pin 1| export_floats |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | converts double to float to reduce file size (default is true) | -| Pin 2| export_flat_vectors |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, vectors and matrices data are exported flat (x1,y1,z1,x2,y2,z2..) (default is false) | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | output file path with .h5 extension | +| Pin 1| export_floats |[`bool`](../../core-concepts/dpf-types.md#standard-types) | converts double to float to reduce file size (default is true) | +| Pin 2| export_flat_vectors |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, vectors and matrices data are exported flat (x1,y1,z1,x2,y2,z2..) (default is false) | | Pin 3
Required| data | | only the data set explicitly to export is exported | ## Outputs @@ -30,7 +30,7 @@ This operator is deprecated: use 'hdf5::h5dpf::make_result_file' instead. Serial | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serializer.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serializer.md index 6eb167fb09..7136fc4821 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serializer.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serializer.md @@ -16,21 +16,21 @@ Take any input and serialize them in a file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| stream_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 for ASCII (default), and 1 for binary | -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1
Required| any_input |[`any`](./../../core-concepts/dpf-types.md#any) | any input | +| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 for ASCII (default), and 1 for binary | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| any_input |[`any`](../../core-concepts/dpf-types.md#any) | any input | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serializer_to_string.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serializer_to_string.md index 02c1db8d66..d802c53911 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serializer_to_string.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/serializer_to_string.md @@ -16,20 +16,21 @@ Take any input and serialize them in a string. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| stream_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 for string (default), and 1 for binary | -| Pin 1
Required| any_input |[`any`](./../../core-concepts/dpf-types.md#any) | any input | +| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 for string (default), 1 for binary, 2 for binary with chunked output (the output string will be returned in several chunks to prevent string memory overflows). | +| Pin 1
Required| any_input |[`any`](../../core-concepts/dpf-types.md#any) | any input | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| serialized_string |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin -1**| nof_chunks |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of chunks when mode passed to input pin(-1) = 2. | +| **Pin 0**| serialized_string |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/string_deserializer.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/string_deserializer.md index 5baafb8277..79dc58a4fd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/string_deserializer.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/string_deserializer.md @@ -16,20 +16,20 @@ Takes a string generated by the serializer and deserializes it into DPF's entiti | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| stream_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 for string (default), and 1 for binary | -| Pin 0
Required| serialized_string |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 for string (default), and 1 for binary | +| Pin 0
Required| serialized_string |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 1**| any_output |[`any`](./../../core-concepts/dpf-types.md#any) | number and types of outputs corresponding of the inputs used in the serialization | +| **Pin 1**| any_output |[`any`](../../core-concepts/dpf-types.md#any) | number and types of outputs corresponding of the inputs used in the serialization | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/txt_to_data_tree.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/txt_to_data_tree.md index 29efffa805..a6986a03a1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/txt_to_data_tree.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/txt_to_data_tree.md @@ -16,19 +16,19 @@ Reads a txt file or string to a DataTree | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| string_or_path |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0
Required| string_or_path |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_tree |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | | +| **Pin 0**| data_tree |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtk_export.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtk_export.md index a1fac9bff7..9ea73561fd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtk_export.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtk_export.md @@ -16,10 +16,10 @@ Write the input field and fields container into a given vtk path | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1| export_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Either export volume elements in the mesh with their fields with value 0 or faces elements in the mesh with their fields with value 1 (default is 0) | -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | path with vtk extension were the export occurs | -| Pin 1| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | necessary if the first field or fields container don't have a mesh in their support | -| Pin 2
Required| fields |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | fields exported | +| Pin -1| export_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Either export volume elements in the mesh with their fields with value 0 or faces elements in the mesh with their fields with value 1 (default is 0) | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | path with vtk extension were the export occurs | +| Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | necessary if the first field or fields container don't have a mesh in their support | +| Pin 2
Required| fields |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | fields exported | ## Outputs @@ -30,7 +30,7 @@ Write the input field and fields container into a given vtk path | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtk_to_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtk_to_fields.md index a24ada8441..944a6c55e8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtk_to_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtk_to_fields.md @@ -16,21 +16,21 @@ Write a field based on a vtk file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| field_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | name of the field in the vtk file | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0| field_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | name of the field in the vtk file | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtu_export.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtu_export.md index f72d8122d4..c0946571c3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtu_export.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/vtu_export.md @@ -16,27 +16,27 @@ Export DPF data into vtu format. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| directory |[`string`](./../../core-concepts/dpf-types.md#standard-types) | directory path | -| Pin 1| base_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | vtu base file name, (default is file) | -| Pin 2
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | mesh | -| Pin 3
Required| fields |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`property_field`](./../../core-concepts/dpf-types.md#property-field) | Nodal, Face, or Elemental field, fields container (over time), or property field to export. When there is no support available in the exported mesh, that data is ignored. | -| Pin 100| write_mode |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Available are rawbinarycompressed, rawbinary, base64appended, base64inline, ascii, default is (rawbinarycompressed) | -| Pin 101| as_point_cloud |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Whether to export the mesh as a point cloud. Default is False. | -| Pin 102| export_faces |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Whether to also export faces as shell elements when the mesh contains cells. Default is False. | -| Pin 103| mesh_properties |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`string_field`](./../../core-concepts/dpf-types.md#string-field) | List of names of mesh properties to export. | +| Pin 0
Required| directory |[`string`](../../core-concepts/dpf-types.md#standard-types) | directory path | +| Pin 1| base_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | vtu base file name, (default is file) | +| Pin 2
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh | +| Pin 3
Required| fields |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | Nodal, Face, or Elemental field, fields container (over time), or property field to export. When there is no support available in the exported mesh, that data is ignored. | +| Pin 100| write_mode |[`string`](../../core-concepts/dpf-types.md#standard-types) | Available are rawbinarycompressed, rawbinary, base64appended, base64inline, ascii, default is (rawbinarycompressed) | +| Pin 101| as_point_cloud |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Whether to export the mesh as a point cloud. Default is False. | +| Pin 102| export_faces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Whether to also export faces as shell elements when the mesh contains cells. Default is False. | +| Pin 103| mesh_properties |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string_field`](../../core-concepts/dpf-types.md#string-field) | List of names of mesh properties to export. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| path |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | list of output vtu file path | +| **Pin 0**| path |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | list of output vtu file path | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/workflow_to_pydpf.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/workflow_to_pydpf.md index 0289e503bf..fa844170a2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/workflow_to_pydpf.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/workflow_to_pydpf.md @@ -17,20 +17,20 @@ The script is returned as a string, and can optionally be saved to a specified p | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | | -| Pin 1| output_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | +| Pin 1| output_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| pydpf_code |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| pydpf_code |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/workflow_to_workflow_topology.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/workflow_to_workflow_topology.md index 8ce9ac9693..b378bf37a2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/workflow_to_workflow_topology.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/workflow_to_workflow_topology.md @@ -16,19 +16,19 @@ Creates a GenericDataContainer based on WorkflowTopology structure from a Workfl | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | | +| Pin 0
Required| workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| workflow_topology |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | | +| **Pin 0**| workflow_topology |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/server/grpc_shutdown_server.md b/2026R1/dpf-framework-26-r1/operator-specifications/server/grpc_shutdown_server.md index 4b04f2bb19..2329fdef0c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/server/grpc_shutdown_server.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/server/grpc_shutdown_server.md @@ -16,7 +16,7 @@ Shutdowns dpf's grpc server | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| grpc_stream |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | dpf streams handling the server | +| Pin 0
Required| grpc_stream |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | dpf streams handling the server | ## Outputs @@ -27,7 +27,7 @@ Shutdowns dpf's grpc server | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/server/grpc_start_server.md b/2026R1/dpf-framework-26-r1/operator-specifications/server/grpc_start_server.md index 16888839cf..f8317d968a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/server/grpc_start_server.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/server/grpc_start_server.md @@ -16,24 +16,24 @@ Starts a dpf's grpc server (if local) or connect to one and keep it waiting for | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| ip |[`string`](./../../core-concepts/dpf-types.md#standard-types) | If no ip address is put, the local ip address is taken | -| Pin 1| port |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | If no port is put, port 50052 is taken | -| Pin 2| starting_option |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | default is 1 that starts server in new thread. With 0, this thread will be waiting for grpc calls and will not be usable for anything else. With 2, it the server will be started in a new process. | -| Pin 3| should_start_server |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, the server is assumed to be local and is started. If false, only a client (able to send grpc calls) will be started | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | A data source with result key 'grpc' and file path 'port:ip' can be used instead of the input port and IP. | -| Pin 5| dpf_context |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | This pin is associated with pin(2) = 2 (server started in a new process). User can enter the integer associated with a DPF context (1: Standalone Context - DpfCoreStandalone.xml, 3: Custom - DpfCustomDefined.xml) or a string with the path of the XML specifying the context. | +| Pin 0| ip |[`string`](../../core-concepts/dpf-types.md#standard-types) | If no ip address is put, the local ip address is taken | +| Pin 1| port |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | If no port is put, port 50052 is taken | +| Pin 2| starting_option |[`int32`](../../core-concepts/dpf-types.md#standard-types) | default is 1 that starts server in new thread. With 0, this thread will be waiting for grpc calls and will not be usable for anything else. With 2, it the server will be started in a new process. | +| Pin 3| should_start_server |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the server is assumed to be local and is started. If false, only a client (able to send grpc calls) will be started | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | A data source with result key 'grpc' and file path 'port:ip' can be used instead of the input port and IP. | +| Pin 5| dpf_context |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | This pin is associated with pin(2) = 2 (server started in a new process). User can enter the integer associated with a DPF context (1: Standalone Context - DpfCoreStandalone.xml, 3: Custom - DpfCustomDefined.xml) or a string with the path of the XML specifying the context. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| grpc_streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | dpf streams handling the server, if the server is started in this thread, then nothing is added in output | +| **Pin 0**| grpc_streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | dpf streams handling the server, if the server is started in this thread, then nothing is added in output | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/append_zeros_to_signal.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/append_zeros_to_signal.md index 944ce6270e..a228140c24 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/append_zeros_to_signal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/append_zeros_to_signal.md @@ -16,20 +16,20 @@ Append samples with value zero at the end of the signal, to extend its duration. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Input signal. | -| Pin 1
Required| duration_to_append |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Duration, in seconds, of the zeros to append to the input signal. | +| Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Input signal. | +| Pin 1
Required| duration_to_append |[`double`](../../core-concepts/dpf-types.md#standard-types) | Duration, in seconds, of the zeros to append to the input signal. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Output signal with appended zeros. The type of the output will be the same as the input on pin 0. For example, a Field as an input will result in a Field for the output. | +| **Pin 0**| output_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Output signal with appended zeros. The type of the output will be the same as the input on pin 0. For example, a Field as an input will result in a Field for the output. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/apply_gain.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/apply_gain.md index 0e7e663a60..c4cfa37cf9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/apply_gain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/apply_gain.md @@ -16,21 +16,21 @@ Apply gain on each channel of a signal (fields_container). Note: The gain is ap | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | The input signal. | -| Pin 1
Required| gain |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Gain value in decibels (dB) or linear unit. By default, gain is specified in decibels. If gain is given in a linear unit, set is_gain_dB to false. | -| Pin 2
Required| is_gain_dB |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If value is true, the gain is specified in dB. If value is false, the gain is in a linear unit. | +| Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | The input signal. | +| Pin 1
Required| gain |[`double`](../../core-concepts/dpf-types.md#standard-types) | Gain value in decibels (dB) or linear unit. By default, gain is specified in decibels. If gain is given in a linear unit, set is_gain_dB to false. | +| Pin 2
Required| is_gain_dB |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If value is true, the gain is specified in dB. If value is false, the gain is in a linear unit. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Signal(s) with the gain applied. The type of the output will be the same as the input on pin 0. For example, a Field as an input will result in a Field for the output. | +| **Pin 0**| output_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Signal(s) with the gain applied. The type of the output will be the same as the input on pin 0. For example, a Field as an input will result in a Field for the output. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_PR.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_PR.md index b43f3f2e0d..27b30e72bf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_PR.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_PR.md @@ -16,20 +16,32 @@ Compute the Prominence Ratio (PR) according to the ECMA-418-1 (formerly ECMA-74, | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_levels |[`field`](./../../core-concepts/dpf-types.md#field) | Input PSD levels in Pa^2/Hz on which to compute PR, as a field. The PSD's frequencies must be regularly spaced. If the PSD's lowest frequency is not 0 Hz, values between 0 Hz and the PSD's lowest frequency are set to 0. | -| Pin 1| frequency_list |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) list of the frequencies of the tones (peaks in the spectrum) for which to compute PR. If this input is empty (not specified), a peak detection method is applied to automatically find the tones in the input spectrum. Then, the PR is calculated for each detected tone. | +| Pin 0
Required| input_levels |[`field`](../../core-concepts/dpf-types.md#field) | Input PSD levels in ^2/Hz on which to compute PR, as a field. The PSD's frequencies must be regularly spaced. If the PSD's lowest frequency is not 0 Hz, values between 0 Hz and the PSD's lowest frequency are set to 0. | +| Pin 1| frequency_list |[`vector`](../../core-concepts/dpf-types.md#standard-types) | (Optional) list of the frequencies of the tones (peaks in the spectrum) for which to compute PR. If this input is empty (not specified), a peak detection method is applied to automatically find the tones in the input spectrum. Then, the PR is calculated for each detected tone. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_PR |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Prominence Ratio data. This data container contains the final PR value (in dB), as well as the PR details for each specified frequency (if input frequency_list is populated) or each detected tone (if input frequency_list is omitted or empty). These details are stored in the class ansys::dpf_sound::PsychoacousticIndicators_PR_results. Use the following identifiers to retrieve each data. - 'PR_max': Maximum (final) PR value in dB, as a double; - 'PR_dB': PR value in dB for each tone, as a field; - 'frequency_Hz': Frequency of each tone in Hz, as a field; - 'level_dB': Level of each tone in dB, as a field; - 'bandwidth_lower_Hz': Lower frequency in Hz of each tone's bandwidth, as a field; - 'bandwidth_higher_Hz': Upper frequency in Hz of each tone's bandwidth, as a field. These data stored in the class PsychoacousticIndicators_PR_results can be accessed using the method GetProperty(property_name). | +| **Pin 0**| output_PR |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Prominence Ratio data. This data container contains the final PR value (in dB), as well as the PR details for each specified frequency (if input frequency_list is populated) +or each detected tone (if input frequency_list is omitted or empty). These details are stored in the class ansys::dpf_sound::PsychoacousticIndicators_PR_results. + +Use the following identifiers to retrieve each piece of data: + +* **PR_max**: Maximum (final) PR value in dB, as a double +* **PR_dB**: PR value in dB for each tone, as a field +* **frequency_Hz**: Frequency of each tone in Hz, as a field +* **level_dB**: Level of each tone in dB, as a field +* **bandwidth_lower_Hz**: Lower frequency in Hz of each tone's bandwidth, as a field +* **bandwidth_higher_Hz**: Upper frequency in Hz of each tone's bandwidth, as a field + +The above data stored in the class PsychoacousticIndicators_PR_results can be accessed using the method GetProperty(property_name) | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_TNR.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_TNR.md index cd52633c43..477ee7a393 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_TNR.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_TNR.md @@ -16,20 +16,32 @@ Compute the Tone-to-Noise Ratio (TNR) according to the ECMA-418-1 (former ECMA-7 | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_levels |[`field`](./../../core-concepts/dpf-types.md#field) | Input PSD levels in Pa^2/Hz on which to compute PR, as a field. The PSD's frequencies must be regularly spaced. If the PSD's lowest frequency is not 0 Hz, values between 0 Hz and the PSD's lowest frequency are set to 0. | -| Pin 1| frequency_list |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) list of the frequencies of the tones (peaks in the spectrum) for which to compute PR. If this input is empty (not specified), a peak detection method is applied to automatically find the tones in the input spectrum. Then, the PR is calculated for each detected tone. | +| Pin 0
Required| input_levels |[`field`](../../core-concepts/dpf-types.md#field) | Input PSD levels in ^2/Hz on which to compute PR, as a field. The PSD's frequencies must be regularly spaced. If the PSD's lowest frequency is not 0 Hz, values between 0 Hz and the PSD's lowest frequency are set to 0. | +| Pin 1| frequency_list |[`vector`](../../core-concepts/dpf-types.md#standard-types) | (Optional) list of the frequencies of the tones (peaks in the spectrum) for which to compute PR. If this input is empty (not specified), a peak detection method is applied to automatically find the tones in the input spectrum. Then, the PR is calculated for each detected tone. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_TNR |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Tone-to-Noise Ratio data. This data container contains the final TNR value (in dB), as well as TNR details for each specified frequency (if input frequency_list is populated) or each detected tone (if input frequency_list is omitted or empty). These details are stored in the class ansys::dpf_sound::PsychoacousticIndicators_TNR_results. Use the following identifiers to retrieve each data. - 'TNR_max': Maximum (final) TNR value in dB, as a double; - 'TNR_dB': TNR value in dB for each tone, as a field; - 'frequency_Hz': Frequency of each tone in Hz, as a field; - 'level_dB': Level of each tone in dB, as a field; - 'bandwidth_lower_Hz': Lower frequency in Hz of each tone's bandwidth, as a field; - 'bandwidth_higher_Hz': Upper frequency in Hz of each tone's bandwidth, as a field. These data stored in the class PsychoacousticIndicators_TNR_results can be accessed using the method GetProperty(property_name). | +| **Pin 0**| output_TNR |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Tone-to-Noise Ratio data. This data container contains the final TNR value (in dB), as well as TNR details for each specified frequency (if input frequency_list is populated) +or each detected tone (if input frequency_list is omitted or empty). These details are stored in the class ansys::dpf_sound::PsychoacousticIndicators_TNR_results. + +Use the following identifiers to retrieve each piece of data: + +* **TNR_max**: Maximum (final) TNR value in dB, as a double +* **TNR_dB**: TNR value in dB for each tone, as a field +* **frequency_Hz**: Frequency of each tone in Hz, as a field +* **level_dB**: Level of each tone in dB, as a field +* **bandwidth_lower_Hz**: Lower frequency in Hz of each tone's bandwidth, as a field +* **bandwidth_higher_Hz**: Upper frequency in Hz of each tone's bandwidth, as a field + +The above data stored in the class PsychoacousticIndicators_TNR_results can be accessed using the method GetProperty(property_name). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_fluctuation_strength.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_fluctuation_strength.md index f03dcebcc8..278eb858ac 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_fluctuation_strength.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_fluctuation_strength.md @@ -16,20 +16,20 @@ Compute the fluctuation strength of a signal based on the master thesis of A. So | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute fluctuation strength. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute fluctuation strength. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_fluctuation_strength |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Fluctuation strength in vacil. | -| **Pin 1**| output_specific_fluctuation_strength |[`field`](./../../core-concepts/dpf-types.md#field) | Specific fluctuation strength in vacil, that is, the fluctuation strength values over Bark band indexes. | +| **Pin 0**| output_fluctuation_strength |[`double`](../../core-concepts/dpf-types.md#standard-types) | Fluctuation strength in vacil. | +| **Pin 1**| output_specific_fluctuation_strength |[`field`](../../core-concepts/dpf-types.md#field) | Specific fluctuation strength in vacil, that is, the fluctuation strength values over Bark band indexes. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_istft.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_istft.md index f7f0708208..cfa4ac6e90 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_istft.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_istft.md @@ -4,7 +4,7 @@ plugin: sound license: avrxp_snd_level1 --- -# sound:compute istft +# sound:compute ISTFT **Version: 0.0.0** @@ -16,20 +16,20 @@ Compute Inverse Short-Time Fourier Transform (ISTFT). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_stft |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The input STFT, obtained using the operator compute_stft.
| +| Pin 0
Required| input_stft |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The input STFT, obtained using the operator compute_stft.
| ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Resulting output temporal signal as a field. +| **Pin 0**| output_signal |[`field`](../../core-concepts/dpf-types.md#field) | Resulting output temporal signal as a field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_level_over_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_level_over_time.md index 6c1cb0f93e..156e91929c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_level_over_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_level_over_time.md @@ -16,27 +16,27 @@ Compute level over time of a signal, on a decibel (dB) scale, or a linear, root- | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal for the level computation. | -| Pin 1| scale_unit |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Expected level scale unit, that is, whether level should be output on a decibel scale, or on a linear, root-mean-square (RMS) scale. Supported values are: - 0: dB; - 1: RMS. Default: 0 (dB). | -| Pin 2| reference_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Reference value for dB calculation. For example, 2e-5 Pa is the reference value for dB SPL, dBA, dBB, and dBC. Reference value is ignored if input scale_unit is set to 1 (RMS). If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. Default: 1.0. | -| Pin 3| frequency_weighting |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Frequency weighting for dB calculation. Frequency weighting is ignored if input scale_unit is set to 1 (RMS). Supported values are: - 0: Z-weigthing (no frequency weighting, use this setting in case dB SPL); - 1: A-weigthing; - 2: B-weigthing; - 3: C-weigthing. If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa.Default: 0 (Z-weighting). | -| Pin 4| time_weighting |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Time weighting for dB calculation, as described in the IEC-61672 standard. Supported values are: - 0: Slow; - 1: Fast; - 2: Impulse; - 3: Custom; Default: 1 (Fast). | -| Pin 5| time_step |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Time step of the level over time calculation, in seconds. Time step is ignored if input time_weighting is not set to 3 (Custom). Default: 0.025 s. | -| Pin 6| window_size |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Window size in seconds, that is, the length of the slice of signal used to calculate the level at each time step. Window size is ignored if input time_weighting is not set to 3 (Custom). Default value: 1s. | -| Pin 7| window_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Type of the window applied to the slice of signal used to calculate the level at each time step. Supported values are:'RECTANGULAR', 'HANN', 'HAMMING', 'BLACKMAN', 'BLACKMANHARRIS', 'BARTLETT'.Default: 'RECTANGULAR'. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal for the level computation. | +| Pin 1| scale_unit |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Expected level scale unit, that is, whether level should be output on a decibel scale, or on a linear, root-mean-square (RMS) scale.

Supported values are:
* **0**: dB
* **1**: RMS

Default: 0 (dB) | +| Pin 2| reference_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Reference value for dB calculation. For example, 2e-5 Pa is the reference value for dB SPL, dBA, dBB, and dBC. Reference value is ignored if input scale_unit is set to 1 (RMS). If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. Default: 1.0. | +| Pin 3| frequency_weighting |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Frequency weighting for dB calculation. Frequency weighting is ignored if input scale_unit is set to 1 (RMS).

Supported values are:

* **0**: Z-weighting (no frequency weighting, use this setting in case dB SPL)
* **1**: A-weighting
* **2**: B-weighting
* **3**: C-weighting

Default: 0 (Z-weighting)

If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. | +| Pin 4| time_weighting |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Time weighting for dB calculation, as described in the IEC-61672 standard.

Supported values are:

* **0**: Slow
* **1**: Fast
* **2**: Impulse
* **3**: Custom

Default: 1 (Fast) | +| Pin 5| time_step |[`double`](../../core-concepts/dpf-types.md#standard-types) | Time step of the level over time calculation, in seconds. Time step is ignored if input time_weighting is not set to 3 (Custom). Default: 0.025 s. | +| Pin 6| window_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | Window size in seconds, that is, the length of the slice of signal used to calculate the level at each time step. Window size is ignored if input time_weighting is not set to 3 (Custom). Default value: 1s. | +| Pin 7| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Type of the window applied to the slice of signal used to calculate the level at each time step.

Supported values are:

* RECTANGULAR
* HANN
* HAMMING
* BLACKMAN
* BLACKMANHARRIS
* BARTLETT

Default: RECTANGULAR | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| maximum_level |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Maximum level attained by the level over time curve, in the unit specified according to inputs (dB, dB SPL, dBA, dBB, dBC or RMS). | -| **Pin 1**| level_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Level over time, in a unit that depends on inputs scale_unit, reference_value, and frequency_weighting. | +| **Pin 0**| maximum_level |[`double`](../../core-concepts/dpf-types.md#standard-types) | Maximum level attained by the level over time curve, in the unit specified according to inputs (dB, dB SPL, dBA, dBB, dBC or RMS). | +| **Pin 1**| level_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Level over time, in a unit that depends on inputs scale_unit, reference_value, and frequency_weighting. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_ansi_s3_4.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_ansi_s3_4.md index f9d50de41f..497e986477 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_ansi_s3_4.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_ansi_s3_4.md @@ -16,21 +16,21 @@ Compute loudness according to the ANSI S3.4-2007 standard. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute loudness. | -| Pin 1| field_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute loudness. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions.

Supported values:

* Free
* Diffuse

Default: Free | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_loudness_sone |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Loudness in sone. | -| **Pin 1**| output_loudness_phon |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Loudness level in phon. | +| **Pin 0**| output_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness in sone. | +| **Pin 1**| output_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness level in phon. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1.md index 8671bf1c22..dd89c37ff4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1.md @@ -16,22 +16,22 @@ Compute loudness according to the ISO532-1 standard for stationary sounds. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute loudness. | -| Pin 1| field_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute loudness. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions.

Supported values:

* Free
* Diffuse

Default: Free | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_loudness_sone |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Loudness in sone. | -| **Pin 1**| output_loudness_phon |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Loudness level in phon. | -| **Pin 2**| output_specific_loudness |[`field`](./../../core-concepts/dpf-types.md#field) | Specific loudness in sone/Bark, that is, the loudness values over Bark band indexes. | +| **Pin 0**| output_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness in sone. | +| **Pin 1**| output_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness level in phon. | +| **Pin 2**| output_specific_loudness |[`field`](../../core-concepts/dpf-types.md#field) | Specific loudness in sone/Bark, that is, the loudness values over Bark band indexes. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1_frequency_input.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1_frequency_input.md index 9d12716097..0e8715b354 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1_frequency_input.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1_frequency_input.md @@ -16,22 +16,22 @@ Compute loudness according to the ISO532-1 standard for stationary sounds, using | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_levels |[`field`](./../../core-concepts/dpf-types.md#field) | Input one-third-octave-band levels in dB SPL on which to compute loudness. Exactly 28 band levels must be provided. Considered one-third-octave bands have the following central frequencies: - Band 1: 25 Hz;- Band 2: 31.5 Hz;- Band 3: 40 Hz;- Band 4: 50 Hz;- Band 5: 63 Hz;- Band 6: 80 Hz;- Band 7: 100 Hz;- Band 8: 125 Hz;- Band 9: 160 Hz;- Band 10: 200 Hz;- Band 11: 250 Hz;- Band 12: 315 Hz;- Band 13: 400 Hz;- Band 14: 500 Hz;- Band 15: 630 Hz;- Band 16: 800 Hz;- Band 17: 1000 Hz;- Band 18: 1250 Hz;- Band 19: 1600 Hz;- Band 20: 2000 Hz;- Band 21: 2500 Hz;- Band 22: 3150 Hz;- Band 23: 4000 Hz;- Band 24: 5000 Hz;- Band 25: 6300 Hz;- Band 26: 8000 Hz;- Band 27: 10000 Hz;- Band 28: 12500 Hz. | -| Pin 1| field_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 0
Required| input_levels |[`field`](../../core-concepts/dpf-types.md#field) | Input one-third-octave-band levels in dB SPL on which to compute loudness. Exactly 28 band levels must be provided.

Considered one-third-octave bands have the following central frequencies:

| Band | Frequency |
|------|-----------|
| 1 | 25 Hz |
| 2 | 31.5 Hz |
| 3 | 40 Hz |
| 4 | 50 Hz |
| 5 | 63 Hz |
| 6 | 80 Hz |
| 7 | 100 Hz |
| 8 | 125 Hz |
| 9 | 160 Hz |
| 10 | 200 Hz |
| 11 | 250 Hz |
| 12 | 315 Hz |
| 13 | 400 Hz |
| 14 | 500 Hz |
| 15 | 630 Hz |
| 16 | 800 Hz |
| 17 | 1000 Hz |
| 18 | 1250 Hz |
| 19 | 1600 Hz |
| 20 | 2000 Hz |
| 21 | 2500 Hz |
| 22 | 3150 Hz |
| 23 | 4000 Hz |
| 24 | 5000 Hz |
| 25 | 6300 Hz |
| 26 | 8000 Hz |
| 27 | 10000 Hz |
| 28 | 12500 Hz | | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions.

Supported values:

* Free
* Diffuse

Default: Free | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_loudness_sone |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Loudness in sone. | -| **Pin 1**| output_loudness_phon |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Loudness level in phon. | -| **Pin 2**| output_specific_loudness |[`field`](./../../core-concepts/dpf-types.md#field) | Specific loudness in sone/Bark, that is, the loudness values over Bark band indexes. | +| **Pin 0**| output_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness in sone. | +| **Pin 1**| output_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness level in phon. | +| **Pin 2**| output_specific_loudness |[`field`](../../core-concepts/dpf-types.md#field) | Specific loudness in sone/Bark, that is, the loudness values over Bark band indexes. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1_vs_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1_vs_time.md index b7064e1c9f..679f72ecaa 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1_vs_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_1_vs_time.md @@ -16,25 +16,25 @@ Compute the loudness over time of an input signal, according to the ISO532-1 sta | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute loundess over time. | -| Pin 1| field_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute loundess over time. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions.

Supported values:

* Free
* Diffuse

Default: Free | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_loudness_sone_vs_time |[`field`](./../../core-concepts/dpf-types.md#field) | Instantaneous loudness in sone. | -| **Pin 1**| output_N5 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | N5 indicator in sone, that is, the loudness value that is exceeded during a cumulated 5 % of the signal duration. | -| **Pin 2**| output_N10 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | N10 indicator in sone, that is, the loudness value that is exceeded during a cumulated 10 % of the signal duration. | -| **Pin 3**| output_loudness_phon_vs_time |[`field`](./../../core-concepts/dpf-types.md#field) | Instantaneous loudness level in phon. | -| **Pin 4**| output_L5 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | L5 indicator in phon, that is, the loudness level value that is exceeded during a cumulated 5 % of the signal duration. | -| **Pin 5**| output_L10 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | L10 indicator in phon, that is, the loudness level value that is exceeded during a cumulated 10 % of the signal duration. | +| **Pin 0**| output_loudness_sone_vs_time |[`field`](../../core-concepts/dpf-types.md#field) | Instantaneous loudness in sone. | +| **Pin 1**| output_N5 |[`double`](../../core-concepts/dpf-types.md#standard-types) | N5 indicator in sone, that is, the loudness value that is exceeded during a cumulated 5 % of the signal duration. | +| **Pin 2**| output_N10 |[`double`](../../core-concepts/dpf-types.md#standard-types) | N10 indicator in sone, that is, the loudness value that is exceeded during a cumulated 10 % of the signal duration. | +| **Pin 3**| output_loudness_phon_vs_time |[`field`](../../core-concepts/dpf-types.md#field) | Instantaneous loudness level in phon. | +| **Pin 4**| output_L5 |[`double`](../../core-concepts/dpf-types.md#standard-types) | L5 indicator in phon, that is, the loudness level value that is exceeded during a cumulated 5 % of the signal duration. | +| **Pin 5**| output_L10 |[`double`](../../core-concepts/dpf-types.md#standard-types) | L10 indicator in phon, that is, the loudness level value that is exceeded during a cumulated 10 % of the signal duration. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_2.md index 9cf8968017..3ed2262a62 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_loudness_iso532_2.md @@ -16,26 +16,26 @@ Compute binaural and monaural loudness according to the ISO532-2 standard. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Input signal in Pa on which to compute loudness. If signal is a FieldsContainer, it must contain exactly two Fields. | -| Pin 1| field_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | -| Pin 2| recording_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Recording system used to measure the input signal (supported values: 'Mic', 'Head'. 'Mic' stands for Single microphone, 'Head' stands for Head and torso simulator). Default: 'Mic'. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Input signal in Pa on which to compute loudness. If signal is a FieldsContainer, it must contain exactly two Fields. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions.

Supported values:

* Free
* Diffuse

Default: Free | +| Pin 2| recording_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Recording system used to measure the input signal.

Supported values:

* **Mic**: Single microphone
* **Head**: Head and torso simulator

Default: Mic | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_binaural_loudness_sone |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Binaural loudness in sone. | -| **Pin 1**| output_binaural_loudness_phon |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Binaural loudness level in phon. | -| **Pin 2**| output_monaural_loudness_sone |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Monaural loudness (left and right) in sone. | -| **Pin 3**| output_monaural_loudness_phon |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Monaural loudness (left and right) level in phon. | -| **Pin 4**| output_binaural_specific_loudness |[`field`](./../../core-concepts/dpf-types.md#field) | Binaural specific loudness in sone/Cam. | -| **Pin 5**| output_monaural_specific_loudness |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Monaural specific loudness (left and right) in sone/Cam. | +| **Pin 0**| output_binaural_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types) | Binaural loudness in sone. | +| **Pin 1**| output_binaural_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types) | Binaural loudness level in phon. | +| **Pin 2**| output_monaural_loudness_sone |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Monaural loudness (left and right) in sone. | +| **Pin 3**| output_monaural_loudness_phon |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Monaural loudness (left and right) level in phon. | +| **Pin 4**| output_binaural_specific_loudness |[`field`](../../core-concepts/dpf-types.md#field) | Binaural specific loudness in sone/Cam. | +| **Pin 5**| output_monaural_specific_loudness |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Monaural specific loudness (left and right) in sone/Cam. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_psd.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_psd.md new file mode 100644 index 0000000000..c46aa999cd --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_psd.md @@ -0,0 +1,50 @@ +--- +category: sound +plugin: sound +license: avrxp_snd_level1 +--- + +# sound:compute octave levels from PSD + +**Version: 0.0.0** + +## Description + +Compute octave-band levels from a power spectral density (PSD) input. Ten bands are considered whose center frequencies range between 31.5 Hz and 16000 Hz + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| psd |[`field`](../../core-concepts/dpf-types.md#field) | Input power spectral density (PSD) for the levels' computation, in ^2/Hz. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| levels |[`field`](../../core-concepts/dpf-types.md#field) | Octave-band levels. The returned level unit is derived from the input PSD's unit (for example, if the PSD is in Pa^2/Hz, the levels will be returned in Pa^2).The field support contains the octave-band center frequencies. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: sound + + **Plugin**: sound + + **Scripting name**: None + + **Full name**: None + + **Internal name**: compute_octave_levels_from_psd + + **License**: avrxp_snd_level1 + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_psd_ansi_s1_11_1986.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_psd_ansi_s1_11_1986.md new file mode 100644 index 0000000000..e77191644a --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_psd_ansi_s1_11_1986.md @@ -0,0 +1,50 @@ +--- +category: sound +plugin: sound +license: avrxp_snd_level1 +--- + +# sound:compute octave levels from PSD (ANSI S1.11-1986) + +**Version: 0.0.0** + +## Description + +Compute octave-band levels from a power spectral density (PSD) input, taking into account ANSI S1.11-1986 / IEC 61260:1995. The ANSI S1.11-1986 standard describes a digital filterbank to use when computing fractional-octave-band levels from a time-domain signal. This operator applies the frequency responses of these filters to the input PSD in order to simulate the application of this filterbank. Then, every consectutive 3 one-third-octave-band levels are summed to obtain an octave-band level. Ten octave bands are considered whose center frequencies range between 31.5 Hz and 16000 Hz + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| psd |[`field`](../../core-concepts/dpf-types.md#field) | Input power spectral density (PSD) for the levels' computation, in ^2/Hz. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| levels |[`field`](../../core-concepts/dpf-types.md#field) | Octave-band levels. The returned level unit is derived from the input PSD's unit (for example, if the PSD is in Pa^2/Hz, the levels will be returned in Pa^2).The field support contains the octave-band center frequencies. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: sound + + **Plugin**: sound + + **Scripting name**: None + + **Full name**: None + + **Internal name**: compute_octave_levels_from_psd_ansi_s1_11_1986 + + **License**: avrxp_snd_level1 + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_signal.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_signal.md new file mode 100644 index 0000000000..7c0306cf52 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_octave_levels_from_signal.md @@ -0,0 +1,50 @@ +--- +category: sound +plugin: sound +license: avrxp_snd_level1 +--- + +# sound:compute octave levels from signal + +**Version: 0.0.0** + +## Description + +Compute octave-band levels from a time-domain signal input. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal for the levels' computation. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| levels |[`field`](../../core-concepts/dpf-types.md#field) | Octave-band levels. The returned level unit is the square of the input signal's unit (for example, if the signal is in Pa, the levels will be returned in Pa^2).The field support contains the octave-band center frequencies. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: sound + + **Plugin**: sound + + **Scripting name**: None + + **Full name**: None + + **Internal name**: compute_octave_levels_from_signal + + **License**: avrxp_snd_level1 + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_psd.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_psd.md new file mode 100644 index 0000000000..b1ad321b8c --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_psd.md @@ -0,0 +1,50 @@ +--- +category: sound +plugin: sound +license: avrxp_snd_level1 +--- + +# sound:compute 1/3-octave levels from PSD + +**Version: 0.0.0** + +## Description + +Compute one-third-octave-band levels from a power spectral density (PSD) input. Twenty-nine bands are considered whose center frequencies range between 25 Hz and 16000 Hz + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| psd |[`field`](../../core-concepts/dpf-types.md#field) | Input power spectral density (PSD) for the levels' computation, in ^2/Hz. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| levels |[`field`](../../core-concepts/dpf-types.md#field) | One-third-octave-band levels. The returned level unit is derived from the input PSD's unit (for example, if the PSD is in Pa^2/Hz, the levels will be returned in Pa^2).The field support contains the one-third-octave-band center frequencies. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: sound + + **Plugin**: sound + + **Scripting name**: None + + **Full name**: None + + **Internal name**: compute_one_third_octave_levels_from_psd + + **License**: avrxp_snd_level1 + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_psd_ansi_s1_11_1986.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_psd_ansi_s1_11_1986.md new file mode 100644 index 0000000000..1bb1154bf6 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_psd_ansi_s1_11_1986.md @@ -0,0 +1,50 @@ +--- +category: sound +plugin: sound +license: avrxp_snd_level1 +--- + +# sound:compute 1/3-octave levels from PSD (ANSI S1.11-1986) + +**Version: 0.0.0** + +## Description + +Compute one-third-octave-band levels from a power spectral density (PSD) input, taking into account ANSI S1.11-1986 / IEC 61260:1995. The ANSI S1.11-1986 standard describes a digital filterbank to use when computing fractional-octave-band levels from a time-domain signal. This operator applies the frequency responses of these filters to the input PSD in order to simulate the application of this filterbank. Twenty-nine bands are considered whose center frequencies range between 25 Hz and 16000 Hz + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| psd |[`field`](../../core-concepts/dpf-types.md#field) | Input power spectral density (PSD) for the levels' computation, in ^2/Hz. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| levels |[`field`](../../core-concepts/dpf-types.md#field) | One-third-octave-band levels. The returned level unit is derived from the input PSD's unit (for example, if the PSD is in Pa^2/Hz, the levels will be returned in Pa^2).The field support contains the one-third-octave-band center frequencies. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: sound + + **Plugin**: sound + + **Scripting name**: None + + **Full name**: None + + **Internal name**: compute_one_third_octave_levels_from_psd_ansi_s1_11_1986 + + **License**: avrxp_snd_level1 + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_signal.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_signal.md new file mode 100644 index 0000000000..a3d5c50971 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_one_third_octave_levels_from_signal.md @@ -0,0 +1,50 @@ +--- +category: sound +plugin: sound +license: avrxp_snd_level1 +--- + +# sound:compute 1/3-octave levels from signal + +**Version: 0.0.0** + +## Description + +Compute one-third-octave-band levels from a time-domain signal input. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal for the levels' computation. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| levels |[`field`](../../core-concepts/dpf-types.md#field) | One-third-octave-band levels. The returned level unit is the square of the input signal's unit (for example, if the signal is in Pa, the levels will be returned in Pa^2).The field support contains the one-third-octave-band center frequencies. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: sound + + **Plugin**: sound + + **Scripting name**: None + + **Full name**: None + + **Internal name**: compute_one_third_octave_levels_from_signal + + **License**: avrxp_snd_level1 + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_overall_level.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_overall_level.md index 25d9a0f0cf..4e5b268050 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_overall_level.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_overall_level.md @@ -16,22 +16,22 @@ Compute the overall level of a signal, on a decibel scale or a linear, root-mean | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal for the level computation. | -| Pin 1| scale_unit |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Expected level scale unit, that is, whether level should be output on a decibel scale, or on a linear, root-mean-square (RMS) scale. Supported values are: - 0: dB; - 1: RMS. Default: 0 (dB). | -| Pin 2| reference_value |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Reference value for dB calculation. For example, 2e-5 Pa is the reference value for dB SPL, dBA, dBB, and dBC. Reference value is ignored if input scale_unit is set to 1 (RMS). If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. Default: 1.0. | -| Pin 3| frequency_weighting |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Frequency weighting for dB calculation. Frequency weighting is ignored if input scale_unit is set to 1 (RMS). Supported values are: - 0: Z-weigthing (no frequency weighting, use this setting in case dB SPL); - 1: A-weigthing; - 2: B-weigthing; - 3: C-weigthing; If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa.Default: 0 (Z-weighting). | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal for the level computation. | +| Pin 1| scale_unit |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Expected level scale unit, that is, whether level should be output on a decibel scale, or on a linear, root-mean-square (RMS) scale.

Supported values are:

* **0**: dB
* **1**: RMS

Default: 0 (dB) | +| Pin 2| reference_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Reference value for dB calculation. For example, 2e-5 Pa is the reference value for dB SPL, dBA, dBB, and dBC.

Reference value is ignored if input scale_unit is set to 1 (RMS).
If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. Default: 1.0. | +| Pin 3| frequency_weighting |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Frequency weighting for dB calculation. Frequency weighting is ignored if input scale_unit is set to 1 (RMS).

Supported values are:

* **0**: Z-weigthing (no frequency weighting, use this setting in case dB SPL)
* **1**: A-weigthing
* **2**: B-weigthing
* **3**: C-weigthing

Default: 0 (Z-weighting)

If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_level |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Overall level, in a unit that depends on inputs scale_unit, reference_value, and frequency_weighting. | +| **Pin 0**| output_level |[`double`](../../core-concepts/dpf-types.md#standard-types) | Overall level, in a unit that depends on inputs scale_unit, reference_value, and frequency_weighting. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_power_spectral_density.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_power_spectral_density.md index 87d47df9f1..c2e2c96a10 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_power_spectral_density.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_power_spectral_density.md @@ -16,23 +16,23 @@ Compute the Power Spectral Density (PSD) of a signal. If the signal's unit is Un | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal for PSD computation. | -| Pin 1
Required| window_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | The window used for the FFT computation, as a string. Supported values are: 'BLACKMAN', 'FLATTOP', 'GAUSS','HAMMING', 'HANN', 'RECTANGULAR', 'TRIANGULAR'. If no parameter is specified, the default value is 'HANN'. | -| Pin 2
Required| window_length |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Length of the analysis window in number of samples. | -| Pin 3
Required| fft_size |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | FFT size in number of samples, must be a power of 2. Should be equal to or greater than window_length. | -| Pin 4
Required| overlap |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Proportion of each window that overlaps with the next, must be in the range [0.0, 1.0[. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal for PSD computation. | +| Pin 1
Required| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | The window used for the FFT computation, as a string.

Supported values are:

* BLACKMAN
* FLATTOP
* GAUSS
* HAMMING
* HANN
* RECTANGULAR
* TRIANGULAR

If no parameter is specified, the default value is 'HANN'. | +| Pin 2
Required| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Length of the analysis window in number of samples. | +| Pin 3
Required| fft_size |[`int32`](../../core-concepts/dpf-types.md#standard-types) | FFT size in number of samples, must be a power of 2. Should be equal to or greater than window_length. | +| Pin 4
Required| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Proportion of each window that overlaps with the next, must be in the range [0.0, 1.0[. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_signal |[`field`](./../../core-concepts/dpf-types.md#field) | One-sided PSD of the input signal, in Unit^2/Hz. | +| **Pin 0**| output_signal |[`field`](../../core-concepts/dpf-types.md#field) | One-sided PSD of the input signal, in Unit^2/Hz. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_prominence_ratio_for_orders_over_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_prominence_ratio_for_orders_over_time.md index 5e0d18b164..91256ee467 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_prominence_ratio_for_orders_over_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_prominence_ratio_for_orders_over_time.md @@ -16,22 +16,22 @@ Compute the Prominence Ratio (PR) over time of a signal, for specific order(s), | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the PR over time for the specified orders. | -| Pin 1
Required| rpm_profile |[`field`](./../../core-concepts/dpf-types.md#field) | Profile of RPM over time associated with the input signal. Must have the same length and same sampling frequency as the input signal. | -| Pin 2
Required| orders_numbers |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | List of the order numbers for which to compute PR. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the PR over time for the specified orders. | +| Pin 1
Required| rpm_profile |[`field`](../../core-concepts/dpf-types.md#field) | Profile of RPM over time associated with the input signal. Must have the same length and same sampling frequency as the input signal. | +| Pin 2
Required| orders_numbers |[`vector`](../../core-concepts/dpf-types.md#standard-types) | List of the order numbers for which to compute PR. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| orders_pr_over_time |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | PR over time, in dB, for each order number specified in input orders_numbers. | -| **Pin 1**| rpm_profile_resampled |[`field`](./../../core-concepts/dpf-types.md#field) | RPM over time, resampled to match the PR computation time steps. | +| **Pin 0**| orders_pr_over_time |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | PR over time, in dB, for each order number specified in input orders_numbers. | +| **Pin 1**| rpm_profile_resampled |[`field`](../../core-concepts/dpf-types.md#field) | RPM over time, resampled to match the PR computation time steps. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_roughness.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_roughness.md index 564004617d..5f1e2b1407 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_roughness.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_roughness.md @@ -16,21 +16,21 @@ Compute the roughness of a signal, based on the reference paper from Daniel and | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute roughness. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute roughness. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| overall_roughness |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Overall roughness in asper. | -| **Pin 1**| specific_roughness |[`field`](./../../core-concepts/dpf-types.md#field) | Specific roughness in asper/Bark, that is, the roughness values over Bark band indexes. | -| **Pin 2**| roughness_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Roughness over time in asper. | +| **Pin 0**| overall_roughness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Overall roughness in asper. | +| **Pin 1**| specific_roughness |[`field`](../../core-concepts/dpf-types.md#field) | Specific roughness in asper/Bark, that is, the roughness values over Bark band indexes. | +| **Pin 2**| roughness_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Roughness over time in asper. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness.md index 7661dbff71..7216c02086 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness.md @@ -16,20 +16,20 @@ Compute the sharpness of a signal, according to Zwicker and Fastl's formula (E. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute sharpness. | -| Pin 1| field_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute sharpness. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions.
Supported values:

* Free
* Diffuse

Default: Free | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_sharpness |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Sharpness in acum. | +| **Pin 0**| output_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sharpness in acum. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_din45692.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_din45692.md index 4a1954d646..3597bf45e8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_din45692.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_din45692.md @@ -16,22 +16,22 @@ Compute the overall sharpness and sharpness over time of a signal, where sharpne | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input in Pa on which to compute the DIN 45692 sharpness. | -| Pin 1| field_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input in Pa on which to compute the DIN 45692 sharpness. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions.

Supported values:

* Free
* Diffuse

Default: Free | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| sharpness |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Overall sharpness in acum (based on ISO 532-1 stationary specific loudness). | -| **Pin 1**| max_sharpness |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Maximum sharpness over time in acum (based on ISO 532-1 time-varying specific loudness). | -| **Pin 2**| sharpness_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Sharpness over time in acum (based on ISO 532-1 time-varying specific loudness). | +| **Pin 0**| sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Overall sharpness in acum (based on ISO 532-1 stationary specific loudness). | +| **Pin 1**| max_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Maximum sharpness over time in acum (based on ISO 532-1 time-varying specific loudness). | +| **Pin 2**| sharpness_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Sharpness over time in acum (based on ISO 532-1 time-varying specific loudness). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_frequency_input.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_frequency_input.md index 8fe63a8a52..dfccb31eea 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_frequency_input.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_frequency_input.md @@ -16,20 +16,20 @@ Compute sharpness according to Zwicker and Fastl's formula (E. Zwicker and H. Fa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_levels |[`field`](./../../core-concepts/dpf-types.md#field) | Input one-third-octave-band levels in dB SPL on which to compute sharpness. Exactly 28 band levels must be provided. Considered one-third-octave bands have the following central frequencies: - Band 1: 25 Hz;- Band 2: 31.5 Hz;- Band 3: 40 Hz;- Band 4: 50 Hz;- Band 5: 63 Hz;- Band 6: 80 Hz;- Band 7: 100 Hz;- Band 8: 125 Hz;- Band 9: 160 Hz;- Band 10: 200 Hz;- Band 11: 250 Hz;- Band 12: 315 Hz;- Band 13: 400 Hz;- Band 14: 500 Hz;- Band 15: 630 Hz;- Band 16: 800 Hz;- Band 17: 1000 Hz;- Band 18: 1250 Hz;- Band 19: 1600 Hz;- Band 20: 2000 Hz;- Band 21: 2500 Hz;- Band 22: 3150 Hz;- Band 23: 4000 Hz;- Band 24: 5000 Hz;- Band 25: 6300 Hz;- Band 26: 8000 Hz;- Band 27: 10000 Hz;- Band 28: 12500 Hz. | -| Pin 1| field_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 0
Required| input_levels |[`field`](../../core-concepts/dpf-types.md#field) | Input one-third-octave-band levels in dB SPL on which to compute sharpness. Exactly 28 band levels must be provided.

Considered one-third-octave bands have the following central frequencies:

| Band | Frequency |
|------|-----------|
| 1 | 25 Hz |
| 2 | 31.5 Hz |
| 3 | 40 Hz |
| 4 | 50 Hz |
| 5 | 63 Hz |
| 6 | 80 Hz |
| 7 | 100 Hz |
| 8 | 125 Hz |
| 9 | 160 Hz |
| 10 | 200 Hz |
| 11 | 250 Hz |
| 12 | 315 Hz |
| 13 | 400 Hz |
| 14 | 500 Hz |
| 15 | 630 Hz |
| 16 | 800 Hz |
| 17 | 1000 Hz |
| 18 | 1250 Hz |
| 19 | 1600 Hz |
| 20 | 2000 Hz |
| 21 | 2500 Hz |
| 22 | 3150 Hz |
| 23 | 4000 Hz |
| 24 | 5000 Hz |
| 25 | 6300 Hz |
| 26 | 8000 Hz |
| 27 | 10000 Hz |
| 28 | 12500 Hz | | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions.

Supported values:

* Free
* Diffuse

Default: Free | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_sharpness |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Sharpness in acum. | +| **Pin 0**| output_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sharpness in acum. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_over_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_over_time.md index 484d5ce967..f724c68e5f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_over_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sharpness_over_time.md @@ -16,21 +16,21 @@ Compute the sharpness over time of a signal, where sharpness is defined in accor | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute sharpness over time. | -| Pin 1| field_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute sharpness over time. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions

Supported values:

* Free
* Diffuse

Default: Free | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| max_sharpness |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Maximum sharpness value over time, in acum. | -| **Pin 1**| sharpness_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Sharpness over time, in acum. | +| **Pin 0**| max_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Maximum sharpness value over time, in acum. | +| **Pin 1**| sharpness_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Sharpness over time, in acum. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sound_power_level_iso3744.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sound_power_level_iso3744.md index d2be4390af..664f6a4aac 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sound_power_level_iso3744.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_sound_power_level_iso3744.md @@ -16,28 +16,28 @@ Compute the sound power level (SWL) according to the ISO 3744 standard. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| surface_shape |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Shape of the measurement surface. Supported values are: 'Hemisphere', 'Half-hemisphere'. | -| Pin 1
Required| surface_radius |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Radius in meters of the hemisphere or half-hemisphere measurement surface. | -| Pin 2
Required| K1 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Background noise correction in dB (section 8.2.3 of ISO 3744). | -| Pin 3
Required| K2 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Environmental correction K2 in dB (Annex A of ISO 3744). | -| Pin 4
Required| C1 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Meteorological reference quantity correction C1 in dB (Annex G of ISO 3744). | -| Pin 5
Required| C2 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Meteorological radiation impedance correction C2 in dB (Annex G of ISO 3744). | -| Pin 6
Required| microphone_signals |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Signals recorded at various microphone positions on the measurement surface: each signal is stored as a field of microphone_signals. | +| Pin 0
Required| surface_shape |[`string`](../../core-concepts/dpf-types.md#standard-types) | Shape of the measurement surface.

Supported values are:

* Hemisphere
* Half-hemisphere | +| Pin 1
Required| surface_radius |[`double`](../../core-concepts/dpf-types.md#standard-types) | Radius in meters of the hemisphere or half-hemisphere measurement surface. | +| Pin 2
Required| K1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Background noise correction in dB (section 8.2.3 of ISO 3744). | +| Pin 3
Required| K2 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Environmental correction K2 in dB (Annex A of ISO 3744). | +| Pin 4
Required| C1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Meteorological reference quantity correction C1 in dB (Annex G of ISO 3744). | +| Pin 5
Required| C2 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Meteorological radiation impedance correction C2 in dB (Annex G of ISO 3744). | +| Pin 6
Required| microphone_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Signals recorded at various microphone positions on the measurement surface: each signal is stored as a field of microphone_signals. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| Lw |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Unweighted sound power level (Lw) in dB. | -| **Pin 1**| LwA |[`double`](./../../core-concepts/dpf-types.md#standard-types) | A-weighted sound power level (Lw(A)) in dBA. | -| **Pin 2**| octave_band |[`field`](./../../core-concepts/dpf-types.md#field) | Octave-band sound power levels, in dB. | -| **Pin 3**| third_octave_band |[`field`](./../../core-concepts/dpf-types.md#field) | One-third-octave-band sound power levels, in dB. | +| **Pin 0**| Lw |[`double`](../../core-concepts/dpf-types.md#standard-types) | Unweighted sound power level (Lw) in dB. | +| **Pin 1**| LwA |[`double`](../../core-concepts/dpf-types.md#standard-types) | A-weighted sound power level (Lw(A)) in dBA. | +| **Pin 2**| octave_band |[`field`](../../core-concepts/dpf-types.md#field) | Octave-band sound power levels, in dB. | +| **Pin 3**| third_octave_band |[`field`](../../core-concepts/dpf-types.md#field) | One-third-octave-band sound power levels, in dB. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_spectral_centroid.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_spectral_centroid.md index f26b47dfd1..94eb5ff12f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_spectral_centroid.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_spectral_centroid.md @@ -16,19 +16,19 @@ Compute the spectral centroid of a signal. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the spectral centroid. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the spectral centroid. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_spectral_centroid |[`double`](./../../core-concepts/dpf-types.md#standard-types) | The spectral centroid value in Hz. | +| **Pin 0**| output_spectral_centroid |[`double`](../../core-concepts/dpf-types.md#standard-types) | The spectral centroid value in Hz. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_stft.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_stft.md index bda7b556d7..b0e5bab730 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_stft.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_stft.md @@ -4,7 +4,7 @@ plugin: sound license: avrxp_snd_level1 --- -# sound:compute stft +# sound:compute STFT **Version: 0.0.0** @@ -16,22 +16,22 @@ Compute Short-Time Fourier Transform (STFT) from a temporal signal. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | The input signal as a field on which to compute the STFT.
| -| Pin 1
Required| fft_size |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Size (as an integer) of the FFT to compute the STFT. Use a power of 2 for better performance.
| -| Pin 2| window_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | The window used for the FFT computation, as a string. Allowed input strings are: 'BLACKMAN', 'FLATTOP', 'GAUSS','HAMMING', 'HANN', 'RECTANGULAR', 'TRIANGULAR'. If no parameter is specified, the default value is 'HANN'. | -| Pin 3| window_overlap |[`double`](./../../core-concepts/dpf-types.md#standard-types) | The overlap value between two successive FFT computations (value between 0 and 1). 0 means no overlap, 0.5 means 50 % overlap. If no parameter is specified, default value is 0.5. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | The input signal as a field on which to compute the STFT.
| +| Pin 1
Required| fft_size |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Size (as an integer) of the FFT to compute the STFT. Use a power of 2 for better performance.
| +| Pin 2| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | The window used for the FFT computation, as a string.
Allowed input strings are:

* BLACKMAN
* FLATTOP
* GAUSS
* HAMMING
* HANN
* RECTANGULAR
* TRIANGULAR

If no parameter is specified, the default value is 'HANN'. | +| Pin 3| window_overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | The overlap value between two successive FFT computations (value between 0 and 1). 0 means no overlap, 0.5 means 50 % overlap. If no value is specified, default value is 0.5. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_stft |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Output STFT (complex), fields container of 2D Matrices. The fields container is indexed by labels "channel_number", time and complex. | +| **Pin 0**| output_stft |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Output (complex) STFT, as a fields container. The fields container is indexed by labels "time" and "complex", and each indexed field corresponds to the real or imaginary part of an STFT slice (spectrum) at the specified time index. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_aures.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_aures.md index 7a8f17caab..d36a04fe19 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_aures.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_aures.md @@ -16,25 +16,25 @@ Compute the tonality of a signal, according to the Aures model (W. Aures, 'Proce | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the Aures tonality. | -| Pin 1| overlap |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Percentage in % of each window that overlaps with the next. Default: 90 %. | -| Pin 2| account_w1 |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Enable (True) or disable (False) the bandwidth weighting w1. Default: False. | -| Pin 3| bw_weighting_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Threshold in dB for the bandwidth weighting w1. The threshold value is ignored if input account_w1 is set to False. Default value: 3 dB. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the Aures tonality. | +| Pin 1| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Percentage in % of each window that overlaps with the next. Default: 90 %. | +| Pin 2| account_w1 |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Enable (True) or disable (False) the bandwidth weighting w1. Default: False. | +| Pin 3| bw_weighting_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Threshold in dB for the bandwidth weighting w1. The threshold value is ignored if input account_w1 is set to False. Default value: 3 dB. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| tonality |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Overall tonality in tonality units (tu). | -| **Pin 1**| tonality_over_time_tu |[`field`](./../../core-concepts/dpf-types.md#field) | Tonality over time in tu. | -| **Pin 2**| wt_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Tonal component weighting wT over time.The tonal component weighting combines 3 weighting functions related to the bandwidth, the frequency, and the prominence of each detected tone. | -| **Pin 3**| wGcr_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Relative loudness weighting wGr over time.The relative loudness weighting accounts for the relative contribution of the tonal loudness to the overall loudness. | +| **Pin 0**| tonality |[`double`](../../core-concepts/dpf-types.md#standard-types) | Overall tonality in tonality units (tu). | +| **Pin 1**| tonality_over_time_tu |[`field`](../../core-concepts/dpf-types.md#field) | Tonality over time in tu. | +| **Pin 2**| wt_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonal component weighting wT over time.The tonal component weighting combines 3 weighting functions related to the bandwidth, the frequency, and the prominence of each detected tone. | +| **Pin 3**| wGcr_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Relative loudness weighting wGr over time.The relative loudness weighting accounts for the relative contribution of the tonal loudness to the overall loudness. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_din45681.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_din45681.md index 99c0266f30..b32c313449 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_din45681.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_din45681.md @@ -16,28 +16,40 @@ Compute the tonality of a signal, according to the DIN 45681 standard. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the DIN 45681 tonality. | -| Pin 1| window_length |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Analysis window length in seconds. Default: 3 s. | -| Pin 2| overlap |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Percentage of each analysis window that overlaps with the next, in %. Default: 0 %. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the DIN 45681 tonality. | +| Pin 1| window_length |[`double`](../../core-concepts/dpf-types.md#standard-types) | Analysis window length in seconds. Default: 3 s. | +| Pin 2| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Percentage of each analysis window that overlaps with the next, in %. Default: 0 %. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_mean_difference_dl |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Tonality (mean difference DL) in dB. | -| **Pin 1**| output_mean_difference_uncertainty |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Tonality's uncertainty in dB. | -| **Pin 2**| output_tonal_adjustment_kt |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Tonal adjustment (Kt) in dB. | -| **Pin 3**| output_decisive_difference_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Tonality over time (decisive difference over time DLj) in dB. | -| **Pin 4**| output_decisive_difference_uncertainty_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Tonality's uncertainty over time in dB. | -| **Pin 5**| output_decisive_frequency_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Decisive frequency over time in Hz. | -| **Pin 6**| output_tonal_adjustment_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Tonal adjustment (Kt) over time in dB. | -| **Pin 7**| output_calculation_details |[`any_collection`](./../../core-concepts/dpf-types.md#any-collection) | DIN 45681 calculation details. This data container contains a collection of the computation details for each analyzed spectrum. For each spectrum, stored details is organized in fields, where each field corresponds to one of the following output parameters, and provides its values for all detected tones: - 'differences': Decisive difference DLj in dB; - 'uncertainties': Uncertainty in dB; - 'frequencies': Decisive frequency in Hz; - 'types': Tone type ('' for individual tones, or 'FG' for groups of tones); - 'critical_band_lower_limits': Critical band lower limit, in Hz; - 'critical_band_upper_limits': Critical band upper limit, in Hz; - 'mean_narrowband_masking_noise_levels': Mean narrow-band masking noise level Ls, in dBA; - 'tone_levels': Tone level Lt, in dBA; - 'masking_noise_levels': Masking noise level Lg, in dBA; - 'masking_indices': Masking index av, in dB. | +| **Pin 0**| output_mean_difference_dl |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonality (mean difference DL) in dB. | +| **Pin 1**| output_mean_difference_uncertainty |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonality's uncertainty in dB. | +| **Pin 2**| output_tonal_adjustment_kt |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonal adjustment (Kt) in dB. | +| **Pin 3**| output_decisive_difference_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonality over time (decisive difference over time DLj) in dB. | +| **Pin 4**| output_decisive_difference_uncertainty_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonality's uncertainty over time in dB. | +| **Pin 5**| output_decisive_frequency_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Decisive frequency over time in Hz. | +| **Pin 6**| output_tonal_adjustment_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonal adjustment (Kt) over time in dB. | +| **Pin 7**| output_calculation_details |[`any_collection`](../../core-concepts/dpf-types.md#any-collection) | DIN 45681 calculation details. This data container contains a collection of the computation details for each analyzed spectrum. +For each spectrum, stored details is organized in fields, where each field corresponds to one of the following output parameters, and provides its values for all detected tones: + +* **differences**: Decisive difference DLj in dB +* **uncertainties**: Uncertainty in dB +* **frequencies**: Decisive frequency in Hz +* **typesv**: Tone type ('' for individual tones, or '**FG**' for groups of tones) +* **critical_band_lower_limits**: Critical band lower limit, in Hz +* **critical_band_upper_limits**: Critical band upper limit, in Hz +* **mean_narrowband_masking_noise_levels**: Mean narrow-band masking noise level Ls, in dBA +* **tone_levels**: Tone level Lt, in dBA +* **masking_noise_levels**: Masking noise level Lg, in dBA +* **masking_indices**: Masking index av, in dB. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_ecma418_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_ecma418_2.md index acb865670e..6f61dea9c8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_ecma418_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_ecma418_2.md @@ -4,33 +4,35 @@ plugin: sound license: avrxp_snd_level1 --- -# sound:compute tonality ECMA 418-2 +# sound:compute tonality ECMA-418-2 **Version: 0.0.0** ## Description -Compute the psychoacoustic tonality of a signal according to the ECMA 418-2 standard (Hearing Model of Sottek). This standard is also know as ECMA74 Annex G. +Compute the psychoacoustic tonality of a signal according to the ECMA-418-2 standard (Hearing Model of Sottek). This standard is also know as ECMA74 Annex G. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the ECMA 418-2 psychoacoustic tonality. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the ECMA-418-2 psychoacoustic tonality. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 2| edition |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Identifier of the standard edition (supported values: 1, for 1st edition, 2020, and 3, for 3rd edition, 2024). Default: 1 | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| tonality |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Psychoacoustic tonality in tuHMS. | -| **Pin 1**| tonality_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Psychoacoustic tonality over time in tuHMS. | -| **Pin 2**| tone_frequency_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Frequency of the most prominent tone over time, in Hz. | +| **Pin 0**| tonality |[`double`](../../core-concepts/dpf-types.md#standard-types) | Psychoacoustic tonality in tuHMS. | +| **Pin 1**| tonality_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Psychoacoustic tonality over time in tuHMS. | +| **Pin 2**| tone_frequency_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Frequency of the most prominent tone over time, in Hz. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_iso1996_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_iso1996_2.md index b26cbb803e..5846971774 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_iso1996_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_iso1996_2.md @@ -16,24 +16,31 @@ Compute the tonal audibility and the tonal adjustment of a signal, according to | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the ISO 1996-2:2007 tonality. | -| Pin 1| noise_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Noise pause detection threshold (also referred to as level excess) in dB. Must be positive. Default: 1 dB. | -| Pin 2| effective_analysis_bw |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Effective analysis bandwidth in Hz. Must be in the range ]0, 5]. Default: 5 Hz. | -| Pin 3| noise_bandwidth |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Must be in the range [0.75, 2]. Default: 0.75. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the ISO 1996-2:2007 tonality. | +| Pin 1| noise_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Noise pause detection threshold (also referred to as level excess) in dB. Must be positive. Default: 1 dB. | +| Pin 2| effective_analysis_bw |[`double`](../../core-concepts/dpf-types.md#standard-types) | Effective analysis bandwidth in Hz. Must be in the range ]0, 5]. Default: 5 Hz. | +| Pin 3| noise_bandwidth |[`double`](../../core-concepts/dpf-types.md#standard-types) | Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Must be in the range [0.75, 2]. Default: 0.75. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| tonality |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Tonal audibility, in dB. | -| **Pin 1**| tonal_adjustement |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Tonal adjustment Kt, in dB. | -| **Pin 2**| calculation_details |[`data_tree`](./../../core-concepts/dpf-types.md#data-tree) | ISO 1996-2:2007 calculation details. The DataTree elements can be accessed, each as a double, using the following identifiers: - 'Tonal audibility (dB)'; - 'Tonal adjustement (dB)'; - 'Lower critical band limit (Hz)'; - 'Higher critical band limit (Hz)'; - 'Total noise level (dBA)'; - 'Total tonal level (dBA)'. | +| **Pin 0**| tonality |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonal audibility, in dB. | +| **Pin 1**| tonal_adjustement |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonal adjustment Kt, in dB. | +| **Pin 2**| calculation_details |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | ISO 1996-2:2007 calculation details. The DataTree elements can be accessed, each as a double, using the following identifiers: + +* Tonal audibility (dB) +* Tonal adjustement (dB) +* Lower critical band limit (Hz) +* Higher critical band limit (Hz) +* Total noise level (dBA) +* Total tonal level (dBA) | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_iso1996_2_over_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_iso1996_2_over_time.md index f362953bb3..e7284480c4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_iso1996_2_over_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_iso1996_2_over_time.md @@ -16,26 +16,36 @@ Compute the tonal audibility and tonal adjustment over time of a signal, where t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the ISO 1996-2:2007 tonality over time. | -| Pin 1| window_length |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Analysis window length in ms. Default: 1000 ms. | -| Pin 2| overlap |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Percentage in % of each analysis window that overlaps with the next. Default: 75 %. | -| Pin 3| noise_threshold |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Noise pause detection threshold (also referred to as level excess) in dB. Must be positive. Default: 1 dB. | -| Pin 4| effective_analysis_bw |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Effective analysis bandwidth in Hz. Must be in the range ]0, 5]. Default: 5 Hz. | -| Pin 5| noise_bandwidth |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Must be in the range [0.75, 2]. Default: 0.75. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the ISO 1996-2:2007 tonality over time. | +| Pin 1| window_length |[`double`](../../core-concepts/dpf-types.md#standard-types) | Analysis window length in ms. Default: 1000 ms. | +| Pin 2| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Percentage in % of each analysis window that overlaps with the next. Default: 75 %. | +| Pin 3| noise_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Noise pause detection threshold (also referred to as level excess) in dB. Must be positive. Default: 1 dB. | +| Pin 4| effective_analysis_bw |[`double`](../../core-concepts/dpf-types.md#standard-types) | Effective analysis bandwidth in Hz. Must be in the range ]0, 5]. Default: 5 Hz. | +| Pin 5| noise_bandwidth |[`double`](../../core-concepts/dpf-types.md#standard-types) | Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Must be in the range [0.75, 2]. Default: 0.75. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| tonality_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Tonal audibility over time, in dB. | -| **Pin 1**| tonal_adjustement_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Tonal ajdustment Kt over time, in dB. | -| **Pin 2**| calculation_details |[`any_collection`](./../../core-concepts/dpf-types.md#any-collection) | ISO 1996-2:2007 over time calculation details. These details are stored in a collection of ansys::dpf_sound::PsychoacousticIndicators_TonalityISO1996_2_OverTime_results. Each element of the collection contains the computation details for a segment of the input signal. For each segment, the computation details consists of the parameters that can be accessed, each as a double, using the following identifiers: - 'segment_start_time_s': start time of the segment under consideration, in s; - 'segment_end_time_s': end time of the segment under consideration, in s; - 'lower_critical_band_limit_Hz': lower critical band limit in Hz of the main detected tone or group of tones; - 'higher_critical_band_limit_Hz': upper critical band limit in Hz of the main detected tone or group of tones; - 'total_noise_level_dBA': total tone level in dBA in the identified critical band; - 'total_tonal_level_dBA': total noise level in dBA in the identified critical band. | +| **Pin 0**| tonality_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonal audibility over time, in dB. | +| **Pin 1**| tonal_adjustement_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonal ajdustment Kt over time, in dB. | +| **Pin 2**| calculation_details |[`any_collection`](../../core-concepts/dpf-types.md#any-collection) | ISO 1996-2:2007 over time calculation details. These details are stored in a collection of ansys::dpf_sound::PsychoacousticIndicators_TonalityISO1996_2_OverTime_results. +Each element of the collection contains the computation details for a segment of the input signal. + +For each segment, the computation details consists of the parameters that can be accessed, each as a double, using the following identifiers: + +* **segment_start_time_s**: start time of the segment under consideration, in s +* **segment_end_time_s**: end time of the segment under consideration, in s +* **lower_critical_band_limit_Hz**: lower critical band limit in Hz of the main detected tone or group of tones +* **higher_critical_band_limit_Hz**: upper critical band limit in Hz of the main detected tone or group of tones +* **total_noise_level_dBA**: total tone level in dBA in the identified critical band +* **total_tonal_level_dBA**: total noise level in dBA in the identified critical band | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_isots_20065.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_isots_20065.md index 808c29a3ba..137f7aa500 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_isots_20065.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tonality_isots_20065.md @@ -16,26 +16,38 @@ Computes tonality according to the ISO/TS 20065:2022 standard | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the tonality ISO/TS 20065:2022. | -| Pin 1| window_length |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Analysis window length in s. Default: 3. | -| Pin 2| overlap |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Percentage in % of each analysis window that overlaps with the next. Default: 0 %. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the tonality ISO/TS 20065:2022. | +| Pin 1| window_length |[`double`](../../core-concepts/dpf-types.md#standard-types) | Analysis window length in s. Default: 3. | +| Pin 2| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Percentage in % of each analysis window that overlaps with the next. Default: 0 %. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_mean_audibility_dl |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Tonality (mean audibility DL) in dB. | -| **Pin 1**| output_mean_audibility_uncertainty |[`field`](./../../core-concepts/dpf-types.md#field) | Tonality's uncertainty in dB. | -| **Pin 2**| output_decisive_audibility_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Tonality over time (decisive audibility over time DLj) in dB. | -| **Pin 3**| output_decisive_audibility_uncertainty_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Tonality's uncertainty over time in dB. | -| **Pin 4**| output_decisive_frequency_over_time |[`field`](./../../core-concepts/dpf-types.md#field) | Decisive frequency over time in Hz. | -| **Pin 5**| output_calculation_details |[`any_collection`](./../../core-concepts/dpf-types.md#any-collection) | ISO/TS 20065:2022 calculation details. This data container contains a collection of the computation details for each analyzed spectrum. For each spectrum, stored details is organized in fields, where each field corresponds to one of the following output parameters, and provides its values for all detected tones: - 'audibility': Decisive audibilities DLj in dB; - 'uncertainties': Uncertainty in dB; - 'frequencies': Decisive frequency in Hz; - 'types': Tone type ('' for individual tones, or 'FG' for groups of tones); - 'critical_band_lower_limits': Critical band lower limit, in Hz; - 'critical_band_upper_limits': Critical band upper limit, in Hz; - 'mean_narrowband_masking_noise_levels': Mean narrow-band masking noise level Ls, in dBA; - 'tone_levels': Tone level Lt, in dBA; - 'masking_noise_levels': Masking noise level Lg, in dBA; - 'masking_indices': Masking index av, in dB. | +| **Pin 0**| output_mean_audibility_dl |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonality (mean audibility DL) in dB. | +| **Pin 1**| output_mean_audibility_uncertainty |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonality's uncertainty in dB. | +| **Pin 2**| output_decisive_audibility_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonality over time (decisive audibility over time DLj) in dB. | +| **Pin 3**| output_decisive_audibility_uncertainty_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonality's uncertainty over time in dB. | +| **Pin 4**| output_decisive_frequency_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Decisive frequency over time in Hz. | +| **Pin 5**| output_calculation_details |[`any_collection`](../../core-concepts/dpf-types.md#any-collection) | ISO/TS 20065:2022 calculation details. This data container contains a collection of the computation details for each analyzed spectrum. +For each spectrum, stored details is organized in fields, where each field corresponds to one of the following output parameters, and provides its values for all detected tones: + +* **audibility**: Decisive audibilities DLj in dB +* **uncertainties**: Uncertainty in dB +* **frequencies**: Decisive frequency in Hz +* **types**: Tone type ('' for individual tones, or '**FG**' for groups of tones) +* **critical_band_lower_limits**: Critical band lower limit, in Hz +* **critical_band_upper_limits**: Critical band upper limit, in Hz +* **mean_narrowband_masking_noise_levels**: Mean narrow-band masking noise level Ls, in dBA +* **tone_levels**: Tone level Lt, in dBA +* **masking_noise_levels**: Masking noise level Lg, in dBA +* **masking_indices**: Masking index av, in dB | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tone_to_noise_ratio_for_orders_over_time.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tone_to_noise_ratio_for_orders_over_time.md index db338de0d4..eb805c6127 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tone_to_noise_ratio_for_orders_over_time.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/compute_tone_to_noise_ratio_for_orders_over_time.md @@ -16,22 +16,22 @@ Compute the Tone-to-Noise Ratio (TNR) over time of a signal, for specific order( | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the TNR over time for the specified orders. | -| Pin 1
Required| rpm_profile |[`field`](./../../core-concepts/dpf-types.md#field) | Profile of RPM over time associated with the input signal. Must have the same length and same sampling frequency as the input signal. | -| Pin 2
Required| orders_numbers |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | List of the order numbers for which to compute TNR. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the TNR over time for the specified orders. | +| Pin 1
Required| rpm_profile |[`field`](../../core-concepts/dpf-types.md#field) | Profile of RPM over time associated with the input signal. Must have the same length and same sampling frequency as the input signal. | +| Pin 2
Required| orders_numbers |[`vector`](../../core-concepts/dpf-types.md#standard-types) | List of the order numbers for which to compute TNR. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| orders_pr_over_time |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | TNR over time, in dB, for each order number specified in input orders_numbers. | -| **Pin 1**| rpm_profile_resampled |[`field`](./../../core-concepts/dpf-types.md#field) | RPM over time, resampled to match the TNR computation time steps. | +| **Pin 0**| orders_pr_over_time |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | TNR over time, in dB, for each order number specified in input orders_numbers. | +| **Pin 1**| rpm_profile_resampled |[`field`](../../core-concepts/dpf-types.md#field) | RPM over time, resampled to match the TNR computation time steps. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_field_from_vector.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_field_from_vector.md index 46f381418a..0d2735bd26 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_field_from_vector.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_field_from_vector.md @@ -16,21 +16,21 @@ Create a DPF field from a vector of samples. This field can then be used as a 's | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| in_data_vector |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Vector containing the signal's samples as double values. The first sample corresponds to time t = 0 s. | -| Pin 1
Required| in_sampling_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Sampling frequency of the signal in Hz. | -| Pin 2
Required| in_unit |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Unit of the signal. | +| Pin 0
Required| in_data_vector |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Vector containing the signal's samples as double values. The first sample corresponds to time t = 0 s. | +| Pin 1
Required| in_sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sampling frequency of the signal in Hz. | +| Pin 2
Required| in_unit |[`string`](../../core-concepts/dpf-types.md#standard-types) | Unit of the signal. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| out_field |[`field`](./../../core-concepts/dpf-types.md#field) | Signal as a DPF field, in the format expected by DPF Sound for a signal. | +| **Pin 0**| out_field |[`field`](../../core-concepts/dpf-types.md#field) | Signal as a DPF field, in the format expected by DPF Sound for a signal. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_automatic_estimation.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_automatic_estimation.md index c8c17db50a..ed8093d860 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_automatic_estimation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_automatic_estimation.md @@ -16,20 +16,20 @@ Automatic XTRACT noise profile estimation from a signal. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Signal (field) from which to estimate the noise profile. | -| Pin 1| window_length |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Window length for the noise level estimation in ms. Default is 50 ms. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Signal (field) from which to estimate the noise profile. | +| Pin 1| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Window length for the noise level estimation in ms. Default is 50 ms. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| noise_profile |[`field`](./../../core-concepts/dpf-types.md#field) | Noise profile (field), to be used as input for the XTRACT denoiser operator. | +| **Pin 0**| noise_profile |[`field`](../../core-concepts/dpf-types.md#field) | Noise profile (field), to be used as input for the XTRACT denoiser operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_noise_samples.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_noise_samples.md index 4d5f934776..220ee76c4a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_noise_samples.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_noise_samples.md @@ -16,21 +16,21 @@ Create a noise profile from an input signal which contains only noise. This prof | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Signal (field) of noise. | -| Pin 1| sampling_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the signal to denoise (which can be different from the signal used for creating the noise profile). Default is the sampling frequency of the noise signal. | -| Pin 2| window_length |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Window length for the noise level estimation in ms. Default value is 50 ms. | +| Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Signal (field) of noise. | +| Pin 1| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the signal to denoise (which can be different from the signal used for creating the noise profile). Default is the sampling frequency of the noise signal. | +| Pin 2| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Window length for the noise level estimation in ms. Default value is 50 ms. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| noise_profile |[`field`](./../../core-concepts/dpf-types.md#field) | Noise profile (field), to be used as input for the XTRACT denoiser operator. | +| **Pin 0**| noise_profile |[`field`](../../core-concepts/dpf-types.md#field) | Noise profile (field), to be used as input for the XTRACT denoiser operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_white_noise_power.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_white_noise_power.md index 6fbba09575..c17236c36e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_white_noise_power.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/create_noise_profile_from_white_noise_power.md @@ -16,21 +16,21 @@ Create a noise profile for XTRACT, given the power level of the white noise. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_white_noise_power |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Power of the white noise (dB SPL). | -| Pin 1
Required| sampling_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Sampling frequency of the signal to denoise (which can be different from the signal used for creating the noise profile). | -| Pin 2| window_length |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Window length for the noise level estimation in ms. Default is 50 ms. | +| Pin 0
Required| input_white_noise_power |[`double`](../../core-concepts/dpf-types.md#standard-types) | Power of the white noise (dB SPL). | +| Pin 1
Required| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sampling frequency of the signal to denoise (which can be different from the signal used for creating the noise profile). | +| Pin 2| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Window length for the noise level estimation in ms. Default is 50 ms. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| noise_profile |[`field`](./../../core-concepts/dpf-types.md#field) | Noise profile (field), to be used as input for the XTRACT denoiser operator. | +| **Pin 0**| noise_profile |[`field`](../../core-concepts/dpf-types.md#field) | Noise profile (field), to be used as input for the XTRACT denoiser operator. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/filter_design_minimum_phase_FIR_filter_from_FRF.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/filter_design_minimum_phase_FIR_filter_from_FRF.md index a3b6691635..0be71ac374 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/filter_design_minimum_phase_FIR_filter_from_FRF.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/filter_design_minimum_phase_FIR_filter_from_FRF.md @@ -16,21 +16,21 @@ Design a minimum-phase Finite Impulse Response (FIR) filter from a Frequency Res | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| frequency_response_function |[`field`](./../../core-concepts/dpf-types.md#field) | Frequency response function (FRF) from which to design the minimum-phase filter. The FRF is expected as a field which contains the gain in dB for each frequency. The frequencies are specified as the time support of the field. | -| Pin 1| sampling_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the coefficients of the returned minimum-phase filter. If no value is specified, the sampling frequency is set to 2 * maximum frequency of the input FRF. | +| Pin 0
Required| frequency_response_function |[`field`](../../core-concepts/dpf-types.md#field) | Frequency response function (FRF) from which to design the minimum-phase filter. The FRF is expected as a field which contains the gain in dB for each frequency. The frequencies are specified as the time support of the field. | +| Pin 1| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the coefficients of the returned minimum-phase filter. If no value is specified, the sampling frequency is set to 2 * maximum frequency of the input FRF. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| filter_b_coefficients |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Coefficients B of the minimum-phase FIR filter designed from the input FRF. | -| **Pin 1**| filter_a_coefficients |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Coefficient A of the minimum-phase FIR filter designed from the input FRF. Note: as it is a FIR filter, A is always filled with the single value 1.0. | +| **Pin 0**| filter_b_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Coefficients B of the minimum-phase FIR filter designed from the input FRF. | +| **Pin 1**| filter_a_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Coefficient A of the minimum-phase FIR filter designed from the input FRF. Note: as it is a FIR filter, A is always filled with the single value 1.0. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/filter_signal.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/filter_signal.md index 3833f1f88a..a1d13d0c7c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/filter_signal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/filter_signal.md @@ -16,21 +16,21 @@ Filters a 1D signal, using a linear, time-invariant digital filter. The filter i | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| signal_to_filter |[`field`](./../../core-concepts/dpf-types.md#field) | Signal to filter. | -| Pin 1
Required| filter_b_coefficients |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Coefficients B of the filter. | -| Pin 2| filter_a_coefficients |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Coefficients A of the filter. | +| Pin 0
Required| signal_to_filter |[`field`](../../core-concepts/dpf-types.md#field) | Signal to filter. | +| Pin 1
Required| filter_b_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Coefficients B of the filter. | +| Pin 2| filter_a_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Coefficients A of the filter. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| filtered_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Filtered signal, as a field. | +| **Pin 0**| filtered_signal |[`field`](../../core-concepts/dpf-types.md#field) | Filtered signal, as a field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/get_cropped_signal.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/get_cropped_signal.md index c298fb8a32..9e4df82cf3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/get_cropped_signal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/get_cropped_signal.md @@ -16,21 +16,21 @@ Crop is used to isolate a part of a signal between a start and end time. Note: C | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | The input signal. | -| Pin 1
Required| start_time_in_sec |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Start time of the part to crop, in seconds. | -| Pin 2
Required| end_time_in_sec |[`double`](./../../core-concepts/dpf-types.md#standard-types) | End time of the part to crop, in seconds. | +| Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | The input signal. | +| Pin 1
Required| start_time_in_sec |[`double`](../../core-concepts/dpf-types.md#standard-types) | Start time of the part to crop, in seconds. | +| Pin 2
Required| end_time_in_sec |[`double`](../../core-concepts/dpf-types.md#standard-types) | End time of the part to crop, in seconds. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Cropped signal. The type of the output will be the same as the input on pin 0. For example, a Field as an input will result in a Field for the output. | +| **Pin 0**| output_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Cropped signal. The type of the output will be the same as the input on pin 0. For example, a Field as an input will result in a Field for the output. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/get_frequency_weighting.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/get_frequency_weighting.md new file mode 100644 index 0000000000..583817166b --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/get_frequency_weighting.md @@ -0,0 +1,51 @@ +--- +category: sound +plugin: sound +license: avrxp_snd_level1 +--- + +# sound:get frequency weighting (A, B, C) + +**Version: 0.0.0** + +## Description + +Retrieve the A-, B-, or C-weighting values, in dB, at the specified frequencies. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| frequencies |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Array of frequencies where weightings shall be returned. | +| Pin 1
Required| frequency_weighting |[`string`](../../core-concepts/dpf-types.md#standard-types) | Frequency weighting.

Supported values are:

* **"A"**: A-weighting,
* **"B"**: B-weighting,
* **"C"**: C-weighting. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| weights |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Values of the required weighting in dB, at the specified frequencies. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: sound + + **Plugin**: sound + + **Scripting name**: None + + **Full name**: None + + **Internal name**: get_frequency_weighting + + **License**: avrxp_snd_level1 + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/isolate_orders.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/isolate_orders.md index 11a8ded8de..c83399f01e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/isolate_orders.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/isolate_orders.md @@ -19,26 +19,26 @@ Isolate orders in a signal. This operator allows you to select the orders of a h | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_time_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | The input signal(s) as a fields container or a field on which to isolate orders.
| -| Pin 1
Required| input_rpm_signal |[`field`](./../../core-concepts/dpf-types.md#field) | The RPM signal associated with the time signals, as a field. It is assumed that the signal's unit is 'RPM'. If this is not the case, inaccurate behavior might occur during the conversion from RPM to frequency. | -| Pin 2
Required| orders_to_extract |[`field`](./../../core-concepts/dpf-types.md#field) | List of the order numbers you want to isolate. Must contain at least one value.
| -| Pin 3
Required| fft_size |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Size (as an integer) of the FFT used to compute the STFT. Use a power of 2 for better performance.
| -| Pin 4| window_type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | The window used for the FFT computation, as a string. Allowed input strings are: 'BLACKMAN', 'FLATTOP', 'GAUSS','HAMMING', 'HANN', 'RECTANGULAR', 'TRIANGULAR'. If no parameter is specified, the default value is 'HANN'. | -| Pin 5| window_overlap |[`double`](./../../core-concepts/dpf-types.md#standard-types) | The overlap value for FFT computation (float value between 0 and 1). If no parameter is specified, the default value is 0.5.
| -| Pin 6| width_order_selection |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | The width, in Hz, of the area used to select each individual order. This area is centered on each order. Note that its precision depends on the FFT size selected in pin 3. If no parameter is specified, the default value is 10 Hz.
| +| Pin 0
Required| input_time_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | The input signal(s) as a fields container or a field on which to isolate orders.
| +| Pin 1
Required| input_rpm_signal |[`field`](../../core-concepts/dpf-types.md#field) | The RPM signal associated with the time signals, as a field. It is assumed that the signal's unit is 'RPM'. If this is not the case, inaccurate behavior might occur during the conversion from RPM to frequency. | +| Pin 2
Required| orders_to_extract |[`field`](../../core-concepts/dpf-types.md#field) | List of the order numbers you want to isolate. Must contain at least one value.
| +| Pin 3
Required| fft_size |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Size (as an integer) of the FFT used to compute the STFT. Use a power of 2 for better performance.
| +| Pin 4| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | The window used for the FFT computation, as a string.
Allowed input strings are:

* BLACKMAN
* FLATTOP
* GAUSS
* HAMMING
* HANN
* RECTANGULAR
* TRIANGULAR

If no parameter is specified, the default value is 'HANN'. | +| Pin 5| window_overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | The overlap value for FFT computation (float value between 0 and 1). If no parameter is specified, the default value is 0.5.
| +| Pin 6| width_order_selection |[`int32`](../../core-concepts/dpf-types.md#standard-types) | The width, in Hz, of the area used to select each individual order. This area is centered on each order. Note that its precision depends on the FFT size selected in pin 3. If no parameter is specified, the default value is 10 Hz.
| ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Resulting output temporal signal as a field container or a field, depending on input type. +| **Pin 0**| output_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Resulting output temporal signal as a field container or a field, depending on input type. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_FRF_from_txt.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_FRF_from_txt.md index d6b2a693df..870eea94fc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_FRF_from_txt.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_FRF_from_txt.md @@ -16,19 +16,19 @@ Loads a Frequency Response Function (FRF) from a text file. The supported files | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the text file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the text file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| frequency_response_function |[`field`](./../../core-concepts/dpf-types.md#field) | The frequency response function (FRF), which contains frequencies in Hz and associated gains in dB, as a field. | +| **Pin 0**| frequency_response_function |[`field`](../../core-concepts/dpf-types.md#field) | The frequency response function (FRF), which contains frequencies in Hz and associated gains in dB, as a field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_project_sound_power_level_iso3744.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_project_sound_power_level_iso3744.md index 4351d49f36..af2e6d88e2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_project_sound_power_level_iso3744.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_project_sound_power_level_iso3744.md @@ -16,25 +16,25 @@ Load a sound power level project file (*.spw), created with Sound SAS. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| project_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the sound power level project file. | +| Pin 0
Required| project_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the sound power level project file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| surface_shape |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Shape of the measurement surface ('Hemisphere', 'Half-hemisphere')'. | -| **Pin 1**| surface_radius |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Radius in meters of the hemisphere or half-hemisphere measurement surface. | -| **Pin 2**| K1 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Background noise correction in dB (section 8.2.3 of ISO 3744). | -| **Pin 3**| K2 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Environmental correction K2 in dB (Annex A of ISO 3744). | -| **Pin 4**| C1 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Meteorological reference quantity correction C1 in dB (Annex G of ISO 3744). | -| **Pin 5**| C2 |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Meteorological radiation impedance correction C2 in dB (Annex G of ISO 3744). | -| **Pin 6**| microphone_signals |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Signals recorded at various microphone positions on the measurement surface: each signal is stored as a field of microphone_signals. | +| **Pin 0**| surface_shape |[`string`](../../core-concepts/dpf-types.md#standard-types) | Shape of the measurement surface ('Hemisphere', 'Half-hemisphere')'. | +| **Pin 1**| surface_radius |[`double`](../../core-concepts/dpf-types.md#standard-types) | Radius in meters of the hemisphere or half-hemisphere measurement surface. | +| **Pin 2**| K1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Background noise correction in dB (section 8.2.3 of ISO 3744). | +| **Pin 3**| K2 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Environmental correction K2 in dB (Annex A of ISO 3744). | +| **Pin 4**| C1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Meteorological reference quantity correction C1 in dB (Annex G of ISO 3744). | +| **Pin 5**| C2 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Meteorological radiation impedance correction C2 in dB (Annex G of ISO 3744). | +| **Pin 6**| microphone_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Signals recorded at various microphone positions on the measurement surface: each signal is stored as a field of microphone_signals. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_sound_samples_from_txt.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_sound_samples_from_txt.md index 360a9d808b..8a58c71f1b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_sound_samples_from_txt.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_sound_samples_from_txt.md @@ -16,19 +16,19 @@ Return a signal (in a field) created with the samples vs time loaded from a txt | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to text file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to text file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| signal |[`field`](./../../core-concepts/dpf-types.md#field) | The signal loaded from the file, as a Field. | +| **Pin 0**| signal |[`field`](../../core-concepts/dpf-types.md#field) | The signal loaded from the file, as a Field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_wav_sas.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_wav_sas.md index 38657a6ae0..a45e106ebf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_wav_sas.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/load_wav_sas.md @@ -16,19 +16,19 @@ Read a wav file created by Ansys Sound SAS, and store the signal(s) in a fields_ | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| in_wav_file |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Path to the wav file to read. | +| Pin 0
Required| in_wav_file |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Path to the wav file to read. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| out_multichannel_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Multichannel signal: container, with each channel as a field. | +| **Pin 0**| out_multichannel_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Multichannel signal: container, with each channel as a field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/resample.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/resample.md index 63e649859f..f0663bc48d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/resample.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/resample.md @@ -16,20 +16,20 @@ Resample a signal to a target sampling frequency. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| signal_to_resample |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Input signal(s) to resample, as a fields_container. Each signal (stored as a field) is resampled. | -| Pin 1
Required| target_fs |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Target sampling frequency, in Hz. | +| Pin 0
Required| signal_to_resample |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Input signal(s) to resample, as a fields_container. Each signal (stored as a field) is resampled. | +| Pin 1
Required| target_fs |[`double`](../../core-concepts/dpf-types.md#standard-types) | Target sampling frequency, in Hz. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| resampled_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Resampled signal(s), whose sampling frequency is target_fs. The type of the output will be the same as the input on pin 0. For example, a Field as an input will result in a Field for the output. | +| **Pin 0**| resampled_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Resampled signal(s), whose sampling frequency is target_fs. The type of the output will be the same as the input on pin 0. For example, a Field as an input will result in a Field for the output. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_bbn.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_bbn.md index d067cb6e98..99acf93bd6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_bbn.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_bbn.md @@ -16,21 +16,21 @@ Generate a sound from a broadband noise model (1 parameter), according to a give | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| source_bbn |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (1 parameter), as a fields container. Each field contains the level vs frequency of the noise at a given value of the control parameter. Level vs frequency may be specified as a Power Spectral Density (PSD) in Pa^2/Hz, or as Octave bands level in Pa^2, or as 1/3 Octave bands level in Pa^2. The unit must be indicated in the field's unit. The type of data (PSD, Octave, 1/3 octave) must be indicated in the field's FieldDefinition attribute, as a quantity_type. | -| Pin 1
Required| control |[`field`](./../../core-concepts/dpf-types.md#field) | Control parameter value vs time, as a field. | -| Pin 2| sampling_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz. | +| Pin 0
Required| source_bbn |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (1 parameter), as a fields container. Each field contains the level vs frequency of the noise at a given value of the control parameter. Level vs frequency may be specified as a Power Spectral Density (PSD) in Pa^2/Hz, or as Octave bands level in Pa^2, or as 1/3 Octave bands level in Pa^2. The unit must be indicated in the field's unit. The type of data (PSD, Octave, 1/3 octave) must be indicated in the field's FieldDefinition attribute, as a quantity_type. | +| Pin 1
Required| control |[`field`](../../core-concepts/dpf-types.md#field) | Control parameter value vs time, as a field. | +| Pin 2| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| generated_sound |[`field`](./../../core-concepts/dpf-types.md#field) | Generated sound, as a field. | +| **Pin 0**| generated_sound |[`field`](../../core-concepts/dpf-types.md#field) | Generated sound, as a field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_bbn_two_parameters.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_bbn_two_parameters.md index 7239476736..534a5a28ae 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_bbn_two_parameters.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_bbn_two_parameters.md @@ -16,22 +16,22 @@ Generate a sound from a broadband noise model (2 parameters), according to a giv | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| source_bbn_two_parameters |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (2 parameters), as a fields container. This fields container is obtained as the output of the operator 'sound_composer_load_source_bbn_two_parameters'. | -| Pin 1
Required| control_1 |[`field`](./../../core-concepts/dpf-types.md#field) | First control parameter value vs time, as a field. | -| Pin 2
Required| control_2 |[`field`](./../../core-concepts/dpf-types.md#field) | Second control parameter value vs time, as a field. | -| Pin 3| sampling_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz. | +| Pin 0
Required| source_bbn_two_parameters |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (2 parameters), as a fields container. This fields container is obtained as the output of the operator 'sound_composer_load_source_bbn_two_parameters'. | +| Pin 1
Required| control_1 |[`field`](../../core-concepts/dpf-types.md#field) | First control parameter value vs time, as a field. | +| Pin 2
Required| control_2 |[`field`](../../core-concepts/dpf-types.md#field) | Second control parameter value vs time, as a field. | +| Pin 3| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| generated_sound |[`field`](./../../core-concepts/dpf-types.md#field) | Generated sound, as a field. | +| **Pin 0**| generated_sound |[`field`](../../core-concepts/dpf-types.md#field) | Generated sound, as a field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_harmonics.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_harmonics.md index ed71dbc2e0..d4072adc6b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_harmonics.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_harmonics.md @@ -16,21 +16,21 @@ Generate a sound from a harmonics (1 parameter) model, according to a given evol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| source_harmonics |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Harmonics (1 parameter) model, as a fields container. Each field contains the level of all orders (the harmonics), at a corresponding RPM value (control parameter). Each field contains the same number of orders, each with the same order numbers, as in the other fields of source_harmonics. The order numbers are stored in the time-frequency support of the field. The control parameter (RPM) vector is stored as the support of the fields container. Levels must be provided in Pa^2. The unit must be specified in each field's unit. | -| Pin 1
Required| rpm_control |[`field`](./../../core-concepts/dpf-types.md#field) | RPM value vs time, as a field. | -| Pin 2| sampling_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz | +| Pin 0
Required| source_harmonics |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Harmonics (1 parameter) model, as a fields container. Each field contains the level of all orders (the harmonics), at a corresponding RPM value (control parameter). Each field contains the same number of orders, each with the same order numbers, as in the other fields of source_harmonics. The order numbers are stored in the time-frequency support of the field. The control parameter (RPM) vector is stored as the support of the fields container. Levels must be provided in Pa^2. The unit must be specified in each field's unit. | +| Pin 1
Required| rpm_control |[`field`](../../core-concepts/dpf-types.md#field) | RPM value vs time, as a field. | +| Pin 2| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| generated_sound |[`field`](./../../core-concepts/dpf-types.md#field) | Generated sound, as a field. | +| **Pin 0**| generated_sound |[`field`](../../core-concepts/dpf-types.md#field) | Generated sound, as a field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_harmonics_two_parameters.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_harmonics_two_parameters.md index b3b707767c..fc3a3563bf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_harmonics_two_parameters.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_harmonics_two_parameters.md @@ -16,22 +16,22 @@ Generate a sound from a Harmonic (2 parameters) model and the evolution of two c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| source_bbn |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Harmonic (2 parameters), as a fields container. Each field contains the level vs orders of the model at a given RPM and control parameter value. Levels must be specified in Pa^2. The unit must be indicated in the field's unit. | -| Pin 1
Required| rpm_control |[`field`](./../../core-concepts/dpf-types.md#field) | RPM value vs time, as a field. | -| Pin 2
Required| control_2 |[`field`](./../../core-concepts/dpf-types.md#field) | Second control parameter value vs time, as a field. | -| Pin 3| sampling_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the output generated sound, in Hz. Default: 44100 Hz. | +| Pin 0
Required| source_bbn |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Harmonic (2 parameters), as a fields container. Each field contains the level vs orders of the model at a given RPM and control parameter value. Levels must be specified in Pa^2. The unit must be indicated in the field's unit. | +| Pin 1
Required| rpm_control |[`field`](../../core-concepts/dpf-types.md#field) | RPM value vs time, as a field. | +| Pin 2
Required| control_2 |[`field`](../../core-concepts/dpf-types.md#field) | Second control parameter value vs time, as a field. | +| Pin 3| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the output generated sound, in Hz. Default: 44100 Hz. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| generated_sound |[`field`](./../../core-concepts/dpf-types.md#field) | Generated sound, as a field. | +| **Pin 0**| generated_sound |[`field`](../../core-concepts/dpf-types.md#field) | Generated sound, as a field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_spectrum.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_spectrum.md index 7e80956fa3..50f8f55c35 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_spectrum.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_generate_sound_spectrum.md @@ -16,22 +16,22 @@ Generate a sound from a spectrum (as a Field), given the duration and the method | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| source_spectrum |[`field`](./../../core-concepts/dpf-types.md#field) | Spectrum, as a Field, from which the sound is generated. The expected unit of this spectrum is Pa^2/Hz. | -| Pin 1
Required| duration |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Duration in seconds of the generated sound. | -| Pin 2
Required| method |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Method to use for the sound generation. Supported input strings are: 'IFFT', 'Hybrid'. | -| Pin 3| sampling_frequency |[`double`](./../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency in Hz of the generated sound. Default: 44100 Hz. | +| Pin 0
Required| source_spectrum |[`field`](../../core-concepts/dpf-types.md#field) | Spectrum, as a Field, from which the sound is generated. The expected unit of this spectrum is Pa^2/Hz. | +| Pin 1
Required| duration |[`double`](../../core-concepts/dpf-types.md#standard-types) | Duration in seconds of the generated sound. | +| Pin 2
Required| method |[`string`](../../core-concepts/dpf-types.md#standard-types) | Method to use for the sound generation. Supported input strings are: 'IFFT', 'Hybrid'. | +| Pin 3| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency in Hz of the generated sound. Default: 44100 Hz. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| generated_sound |[`field`](./../../core-concepts/dpf-types.md#field) | Generated sound, as a Field. | +| **Pin 0**| generated_sound |[`field`](../../core-concepts/dpf-types.md#field) | Generated sound, as a Field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_project.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_project.md index b4aad49ac1..0f52a3ffdd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_project.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_project.md @@ -16,20 +16,20 @@ Load a Sound Composer project from a .scn file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the project file to load. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the project file to load. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| sound_composer_project |[`any_collection`](./../../core-concepts/dpf-types.md#any-collection) | DPF object that contains the loaded Sound Composer project. | -| **Pin 1**| sound_composer_project_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Name of the loaded Sound Composer project. | +| **Pin 0**| sound_composer_project |[`any_collection`](../../core-concepts/dpf-types.md#any-collection) | DPF object that contains the loaded Sound Composer project. | +| **Pin 1**| sound_composer_project_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Name of the loaded Sound Composer project. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_bbn.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_bbn.md index af8b380ca4..e08b801285 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_bbn.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_bbn.md @@ -16,19 +16,19 @@ Load a broadband noise (BBN) model (1 parameter) from a file. Supported files ar | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the broadband noise (1 parameter) file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the broadband noise (1 parameter) file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| source_bbn |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (1 parameter) read from the file, as a fields container. | +| **Pin 0**| source_bbn |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (1 parameter) read from the file, as a fields container. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_bbn_two_parameters.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_bbn_two_parameters.md index c564baabc2..681cae6307 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_bbn_two_parameters.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_bbn_two_parameters.md @@ -16,19 +16,19 @@ Load a broadband noise (BBN) model (2 parameters) from a file. Supported files a | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the broadband noise (2 parameters) file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the broadband noise (2 parameters) file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| source_bbn_two_parameters |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (2 parameters) read from the file, as a fields container. | +| **Pin 0**| source_bbn_two_parameters |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (2 parameters) read from the file, as a fields container. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_harmonics.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_harmonics.md index 32633bbe40..d02a613249 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_harmonics.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_harmonics.md @@ -16,19 +16,19 @@ Load a harmonics (1 parameter) model from a file. Supported files are text files | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the harmonics (1 parameter) file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the harmonics (1 parameter) file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| source_harmonics |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The harmonics (1 parameter) model, as a fields container. | +| **Pin 0**| source_harmonics |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The harmonics (1 parameter) model, as a fields container. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_harmonics_two_parameters.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_harmonics_two_parameters.md index 02053e0872..70fd0804de 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_harmonics_two_parameters.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_harmonics_two_parameters.md @@ -16,19 +16,19 @@ Load a Harmonics (2 parameters) source from a file. Supported files are text fil | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the harmonics (2 parameters) source file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the harmonics (2 parameters) source file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| source_harmonics_two_parameters |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | The harmonics (2 parameters) source, as a fields container. | +| **Pin 0**| source_harmonics_two_parameters |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | The harmonics (2 parameters) source, as a fields container. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_spectrum.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_spectrum.md index c0beba128f..62d3d233ca 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_spectrum.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_load_source_spectrum.md @@ -16,19 +16,19 @@ Load a source of type Spectrum from a file. Supported files are XML files and te | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the spectrum source file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the spectrum source file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| source_spectrum |[`field`](./../../core-concepts/dpf-types.md#field) | The spectrum read from the file, as a Field, with unit Pa^2/Hz. | +| **Pin 0**| source_spectrum |[`field`](../../core-concepts/dpf-types.md#field) | The spectrum read from the file, as a Field, with unit Pa^2/Hz. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_save_project.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_save_project.md index a0422f52df..6b25b8fcc0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_save_project.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sound_composer_save_project.md @@ -16,9 +16,9 @@ Save a Sound Composer project in a .scn file. This file can be opened in Ansys S | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the file to save. | -| Pin 1
Required| sound_composer_project |[`any_collection`](./../../core-concepts/dpf-types.md#any-collection) | DPF object that contains the Sound Composer project to save. | -| Pin 2
Required| sound_composer_project_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Name of the Sound Composer project to save. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the file to save. | +| Pin 1
Required| sound_composer_project |[`any_collection`](../../core-concepts/dpf-types.md#any-collection) | DPF object that contains the Sound Composer project to save. | +| Pin 2
Required| sound_composer_project_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Name of the Sound Composer project to save. | ## Outputs @@ -29,7 +29,7 @@ Save a Sound Composer project in a .scn file. This file can be opened in Ansys S | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sum_signals.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sum_signals.md index ef0fb76a49..05f1950c27 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/sum_signals.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/sum_signals.md @@ -16,19 +16,19 @@ Sample-by-sample sum of all the signals (fields) of an input fields_container, i | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Input signals to sum: each signal is a field of input_signal. | +| Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Input signals to sum: each signal is a field of input_signal. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_signal |[`field`](./../../core-concepts/dpf-types.md#field) | Output signal: sample-by-sample sum ot the input signals. | +| **Pin 0**| output_signal |[`field`](../../core-concepts/dpf-types.md#field) | Output signal: sample-by-sample sum ot the input signals. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/write_wav_sas.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/write_wav_sas.md index d28436ed45..22a56d18f5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/write_wav_sas.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/write_wav_sas.md @@ -16,9 +16,9 @@ Writes signal(s) (fields_container) to a wav file (Ansys Sound SAS wav format). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| in_multi_channel_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Signal to save: fields_container with each channel as a field. | -| Pin 1
Required| out_path_and_file_name |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Path of the wav file to save. | -| Pin 2
Required| type |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Bit depth. Supported values are: 'float32', 'int32', 'int16', 'int8'.
This means that the samples will be respectively coded into the wav file using 32 bits (32-bit IEEE Float), 32 bits (int), 16 bits (int) or 8 bits (int). | +| Pin 0
Required| in_multi_channel_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Signal to save: fields_container with each channel as a field. | +| Pin 1
Required| out_path_and_file_name |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Path of the wav file to save. | +| Pin 2
Required| type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Bit depth. Supported values are: 'float32', 'int32', 'int16', 'int8'.
This means that the samples will be respectively coded into the wav file using 32 bits (32-bit IEEE Float), 32 bits (int), 16 bits (int) or 8 bits (int). | ## Outputs @@ -29,7 +29,7 @@ Writes signal(s) (fields_container) to a wav file (Ansys Sound SAS wav format). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract.md index f8d0fa863d..1382e918cb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract.md @@ -16,25 +16,25 @@ XTRACT processing: in the same way as in Sound SAS, this operator chains a denoi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Signal(s) on which to apply the XTRACT processing, as a field or fields_container. | -| Pin 1
Required| parameters_denoiser |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the denoising step:
- Noise levels (Field): level vs frequency of the noise.
This structure is of type Xtract_denoiser_parameters (see this class for more details).
| -| Pin 2
Required| parameters_tonal |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the tonal extraction step:
- Nfft (int) in number of samples
- Regularity setting (float) in percent
- Maximum slope (float) in dB/Hz
- Minimum duration (float) in seconds
- Intertonal gap (float) in Hz
- Local emergence (float) in dB
This structure is of type Xtract_tonal_parameters (see this class for more details).
| -| Pin 3
Required| parameters_transient |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the transient extraction step:
- Lower threshold (float), between 0 and 100 percent
- Upper threshold (float), between 0 and 100 percent
This structure is of type Xtract_transient_parameters (see this class for more details).
| +| Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Signal(s) on which to apply the XTRACT processing, as a field or fields_container. | +| Pin 1
Required| parameters_denoiser |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the denoising step:

* Noise levels (Field): level vs frequency of the noise.

This structure is of type Xtract_denoiser_parameters (see this class for more details). | +| Pin 2
Required| parameters_tonal |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the tonal extraction step:

* Nfft (int) in number of samples
* Regularity setting (float) in percent
* Maximum slope (float) in dB/Hz
* Minimum duration (float) in seconds
* Intertonal gap (float) in Hz
* Local emergence (float) in dB

This structure is of type Xtract_tonal_parameters (see this class for more details). | +| Pin 3
Required| parameters_transient |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the transient extraction step:

* Lower threshold (float), between 0 and 100 percent
* Upper threshold (float), between 0 and 100 percent

This structure is of type Xtract_transient_parameters (see this class for more details). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| noise_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Noise signal: signal that contains the noise component, as a field or fields_container (depending on the input). | -| **Pin 1**| tonal_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Tonal signal: signal that contains the tonal components, as a field or fields_container (depending on the input). | -| **Pin 2**| transient_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Tonal signal: signal that contains the transient components, as a field or fields_container (depending on the input). | -| **Pin 3**| remainder_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Remainder: signal that contains everything that has not been classified as noise, tonal or transient signals, as a field or fields_container (depending on the input). | +| **Pin 0**| noise_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Noise signal: signal that contains the noise component, as a field or fields_container (depending on the input). | +| **Pin 1**| tonal_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Tonal signal: signal that contains the tonal components, as a field or fields_container (depending on the input). | +| **Pin 2**| transient_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Tonal signal: signal that contains the transient components, as a field or fields_container (depending on the input). | +| **Pin 3**| remainder_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Remainder: signal that contains everything that has not been classified as noise, tonal or transient signals, as a field or fields_container (depending on the input). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_denoiser.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_denoiser.md index 2a7ef89aba..d2d6a8cf85 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_denoiser.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_denoiser.md @@ -16,21 +16,21 @@ Signal denoising using the XTRACT algorithm. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Signal(s) to denoise, as a field or fields_container. When inputting a fields_container, each signal (each field of the fields_container) is processed individually. | -| Pin 1
Required| input_parameters |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the algorithm:
- Noise levels (Field): level vs frequency of the noise.
This structure is of type Xtract_denoiser_parameters (see this class for more details).
| +| Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Signal(s) to denoise, as a field or fields_container. When inputting a fields_container, each signal (each field of the fields_container) is processed individually. | +| Pin 1
Required| input_parameters |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the algorithm:

* Noise levels (Field): level vs frequency of the noise.

This structure is of type Xtract_denoiser_parameters (see this class for more details). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_denoised_signals |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Denoised signal(s), as a field or fields_container (depending on the input). | -| **Pin 1**| output_noise_signals |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Noise signal, as a field or fields_container (depending on the input). The noise signal is the original signal minus the denoised signal. | +| **Pin 0**| output_denoised_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Denoised signal(s), as a field or fields_container (depending on the input). | +| **Pin 1**| output_noise_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Noise signal, as a field or fields_container (depending on the input). The noise signal is the original signal minus the denoised signal. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_tonal.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_tonal.md index ee259101d7..b6b8fd3ae8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_tonal.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_tonal.md @@ -16,21 +16,21 @@ Tonal components detection and isolation, using the XTRACT algorithm. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Signal(s) from which we want to extract tonal components, as a field or fields_container. When inputting a fields_container, each signal (each field of the fields_container) is processed individually. | -| Pin 1
Required| input_parameters |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the algorithm:
- Nfft (int) in number of samples
- Regularity setting between 0 (0%) and 1 (100%). For more information, refer to Ansys Sound SAS documentation.
- Maximum slope (float) in dB/Hz
- Minimum duration (float) in seconds
- Intertonal gap (float) in Hz
- Local smergence (float) in dB
This structure is of type Xtract_tonal_parameters (see this class for more details).
| +| Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Signal(s) from which we want to extract tonal components, as a field or fields_container. When inputting a fields_container, each signal (each field of the fields_container) is processed individually. | +| Pin 1
Required| input_parameters |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the algorithm:

* Nfft (int) in number of samples
* Regularity setting between 0 (0%) and 1 (100%). For more information, refer to Ansys Sound SAS documentation.
* Maximum slope (float) in dB/Hz
* Minimum duration (float) in seconds
* Intertonal gap (float) in Hz
* Local smergence (float) in dB

This structure is of type Xtract_tonal_parameters (see this class for more details). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_tonal_signals |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Tonal signal: signal that contains the tonal components, as a field or fields_container (depending on the input). | -| **Pin 1**| output_non_tonal_signals |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Non-tonal signal: original signal minus tonal signal, as a field or fields_container (depending on the input). | +| **Pin 0**| output_tonal_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Tonal signal: signal that contains the tonal components, as a field or fields_container (depending on the input). | +| **Pin 1**| output_non_tonal_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Non-tonal signal: original signal minus tonal signal, as a field or fields_container (depending on the input). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_transient.md b/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_transient.md index fecd59c6ef..58c1f3d1a8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_transient.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/sound/xtract_transient.md @@ -16,21 +16,21 @@ Transient components detection and extraction using the XTRACT algorithm. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_signal |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Signal(s) from which we want to extract transient components, as a field or fields_container. When inputting a fields_container, each signal (each field of the fields_container) is processed individually. | -| Pin 1
Required| input_parameters |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the algorithm:
- Lower threshold (float), between 0 and 100
- Upper threshold (float), between 0 and 100
This structure is of type Xtract_transient_parameters (see this class for more details).
| +| Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Signal(s) from which we want to extract transient components, as a field or fields_container. When inputting a fields_container, each signal (each field of the fields_container) is processed individually. | +| Pin 1
Required| input_parameters |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Structure that contains the parameters of the algorithm:

* Lower threshold (float), between 0 and 100
* Upper threshold (float), between 0 and 100

This structure is of type Xtract_transient_parameters (see this class for more details). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_transient_signals |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Transient signal(s), as a field or fields_container (depending on the input). | -| **Pin 1**| output_non_transient_signals |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | Non-transient signal(s): original signal minus transient signal, as a field or fields_container (depending on the input). | +| **Pin 0**| output_transient_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Transient signal(s), as a field or fields_container (depending on the input). | +| **Pin 1**| output_non_transient_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Non-transient signal(s): original signal minus transient signal, as a field or fields_container (depending on the input). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_matrices.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_matrices.md index fa5e2bc491..029ddf75c9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_matrices.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_matrices.md @@ -16,28 +16,28 @@ Take nine scalar fields and assemble them as a 3x3 matrix field. If the 'symmetr | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| xx |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1| yy |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 2| zz |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 3| xy |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 4| yz |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 5| xz |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 6| yx |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 7| zy |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 8| zx |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 60| symmetrical |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0| xx |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1| yy |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 2| zz |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 3| xy |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 4| yz |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 5| xz |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 6| yx |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 7| zy |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 8| zx |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 60| symmetrical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_matrices_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_matrices_fc.md index 0dfa537e24..6ecad33735 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_matrices_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_matrices_fc.md @@ -16,28 +16,28 @@ Take nine scalar fields container and assemble them as a 3x3 matrix fields. If t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| xx |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| yy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2| zz |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| xy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 4| yz |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 5| xz |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 6| yx |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 7| zy |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 8| zx |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 60| symmetrical |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0| xx |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| yy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 2| zz |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 3| xy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 4| yz |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 5| xz |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 6| yx |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 7| zy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 8| zx |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 60| symmetrical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_vectors.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_vectors.md index ecd4882a4a..1a316cd5a8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_vectors.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_vectors.md @@ -16,21 +16,21 @@ Takes three scalar fields and assembles them as a 3D vector field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| x |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1| y |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 2| z |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0| x |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1| y |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 2| z |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_vectors_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_vectors_fc.md index 2ac34f3b7c..88c005649d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_vectors_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/assemble_scalars_to_vectors_fc.md @@ -16,21 +16,21 @@ Takes three scalar fields container and assembles them as a 3D vector fields con | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| x |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| y |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2| z |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0| x |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1| y |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 2| z |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support.md index 89dd937409..cf616806ce 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support.md @@ -16,20 +16,20 @@ Ties a support to a field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| support |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), `abstract_field_support` | meshed region or a support of the field | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 1
Required| support |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), abstract_field_support | meshed region or a support of the field | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support_fc.md index 12e79bd6cc..5c95480169 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support_fc.md @@ -16,20 +16,20 @@ Ties a support to a fields container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| support |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), `abstract_field_support`, [`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | Meshed region or a support of the field. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| support |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), abstract_field_support, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | Meshed region or a support of the field. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_location.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_location.md index 200f2d266f..292cb0e881 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_location.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_location.md @@ -16,20 +16,20 @@ change the location of a field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| new_location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | new location of the output field ex 'Nodal', 'ElementalNodal', 'Elemental'... | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| new_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | new location of the output field ex 'Nodal', 'ElementalNodal', 'Elemental'... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_shell_layers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_shell_layers.md index 78a3682697..4084ad3734 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_shell_layers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_shell_layers.md @@ -16,23 +16,23 @@ Extract the requested shell layers from the input fields. If the fields contain | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| e_shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types), `enum dataProcessing::EShellLayers` | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. | -| Pin 2| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | Mesh support of the input fields_container, in case it does not have one defined. If the fields_container contains mixed shell/solid results, the mesh is required (either by connecting this pin or in the support). | -| Pin 26| merge |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For fields with mixed shell layers (solid/shell elements with heterogeneous shell layers), group all of them in the same field (false by default). | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| e_shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types), enum dataProcessing::EShellLayers | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | +| Pin 2| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | Mesh support of the input fields_container, in case it does not have one defined. If the fields_container contains mixed shell/solid results, the mesh is required (either by connecting this pin or in the support). | +| Pin 26| merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For fields with mixed shell layers (solid/shell elements with heterogeneous shell layers), group all of them in the same field (false by default). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | If permissive is set to false, the operator run will ensure the 'change shell layers' operation is allowed (for example, if asking mid layer for a field defined on top and bottom layers, the computed field will be empty). If permissive is set to true, the operator run will be done in a permissive way (no check). Default is true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | If permissive is set to false, the operator run will ensure the 'change shell layers' operation is allowed (for example, if asking mid layer for a field defined on top and bottom layers, the computed field will be empty). If permissive is set to true, the operator run will be done in a permissive way (no check). Default is true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/compute_time_scoping.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/compute_time_scoping.md index 26c672e788..5177fa6caf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/compute_time_scoping.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/compute_time_scoping.md @@ -16,23 +16,23 @@ Computes the time frequency scoping (made of set IDs) necessary to interpolate o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_values |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`field`](./../../core-concepts/dpf-types.md#field), [`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | List of frequencies or times needed. To specify load steps, put a field (and not a list) in input with a scoping located on "TimeFreq_steps". | -| Pin 2| step |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 4| interpolation_type |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 1:ramped' or 2:stepped', default is ramped | -| Pin 8
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 0
Required| time_freq_values |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | List of frequencies or times needed. To specify load steps, put a field (and not a list) in input with a scoping located on "TimeFreq_steps". | +| Pin 2| step |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 4| interpolation_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1:ramped' or 2:stepped', default is ramped | +| Pin 8
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | time_scoping | -| **Pin 1**| field |[`field`](./../../core-concepts/dpf-types.md#field) | time_freq_values | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | time_scoping | +| **Pin 1**| field |[`field`](../../core-concepts/dpf-types.md#field) | time_freq_values | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/customtypefield_get_attribute.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/customtypefield_get_attribute.md new file mode 100644 index 0000000000..888a5f3f5e --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/customtypefield_get_attribute.md @@ -0,0 +1,51 @@ +--- +category: utility +plugin: core +license: None +--- + +# utility:custom type field get attribute + +**Version: 0.0.0** + +## Description + +Gets a property from an input field/field container. A CustomTypeFieldin pin 0, a property name (string) in pin 1 are expected as inputs + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| custom_type_field |[`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| property |[`string`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: utility + + **Plugin**: core + + **Scripting name**: customtypefield_get_attribute + + **Full name**: utility.customtypefield_get_attribute + + **Internal name**: customtypefield::get_attribute + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/default_value.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/default_value.md index 923e25362a..8be6429ad4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/default_value.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/default_value.md @@ -29,7 +29,7 @@ Default return value from input pin 1 to output pin 0 if there is nothing on inp | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/delegate_to_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/delegate_to_operator.md index e79acd8e92..1820c58899 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/delegate_to_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/delegate_to_operator.md @@ -16,19 +16,19 @@ Delegate the run to an Operator instantiated by the name in input (forwards all | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| operator_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin -1
Required| operator_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| any |[`any`](./../../core-concepts/dpf-types.md#any) | inputs | +| **Pin 0**| any |[`any`](../../core-concepts/dpf-types.md#any) | inputs | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/ds_get_attribute.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/ds_get_attribute.md index a729ae8de3..afed262699 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/ds_get_attribute.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/ds_get_attribute.md @@ -16,23 +16,23 @@ A DataSources in pin 0 and a property name (string) in pin 1 are expected in inp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Accepted inputs are: 'file_path' (returns string), 'result_file_name' (returns string), 'domain_file_path' (returns string), 'domain_result_file_name' (returns string), 'num_keys' (returns int), num_result_key (returns int), num_file_path (returns int), 'num_result_file_path' (returns int), 'key_by_index' (returns string), 'result_key_by_index' (returns string), 'path_by_index' (returns string), 'path_key_by_index' (returns string). | -| Pin 2| property_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Index for the property. Must be set for 'domain_file_path', 'domain_result_file_name' 'key_by_index', 'result_key_by_index', 'path_by_index' and 'path_key_by_index' properties. | -| Pin 3| property_key |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Key to look for. Must be set for 'file_path' and 'domain_file_path' properties. | -| Pin 4| property_result_key |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Result key to look for. Can be used for 'file_path', 'result_file_name', 'domain_file_path' and 'domain_result_file_name'. | +| Pin 0
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Accepted inputs are: 'file_path' (returns string), 'result_file_name' (returns string), 'domain_file_path' (returns string), 'domain_result_file_name' (returns string), 'num_keys' (returns int), num_result_key (returns int), num_file_path (returns int), 'num_result_file_path' (returns int), 'key_by_index' (returns string), 'result_key_by_index' (returns string), 'path_by_index' (returns string), 'path_key_by_index' (returns string). | +| Pin 2| property_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index for the property. Must be set for 'domain_file_path', 'domain_result_file_name' 'key_by_index', 'result_key_by_index', 'path_by_index' and 'path_key_by_index' properties. | +| Pin 3| property_key |[`string`](../../core-concepts/dpf-types.md#standard-types) | Key to look for. Must be set for 'file_path' and 'domain_file_path' properties. | +| Pin 4| property_result_key |[`string`](../../core-concepts/dpf-types.md#standard-types) | Result key to look for. Can be used for 'file_path', 'result_file_name', 'domain_file_path' and 'domain_result_file_name'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | Property value. | +| **Pin 0**| property |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Property value. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_field.md index fe084ba41e..df83927995 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_field.md @@ -16,20 +16,20 @@ Extracts the fields at the indices defined in the vector (in 1) from the fields | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | if a field is in input, it is passed on as an output | -| Pin 1| indices |[`vector`](./../../core-concepts/dpf-types.md#standard-types) | Default is the first field | +| Pin 0
Required| fields_container |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | if a field is in input, it is passed on as an output | +| Pin 1| indices |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Default is the first field | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_scoping.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_scoping.md index ff134afa0a..b81b2916a8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_scoping.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_scoping.md @@ -10,25 +10,26 @@ license: None ## Description -Takes a field or a fields container and extracts its scoping or scopings container. +Takes a field type object, mesh or a collection of them and extracts its scoping or scopings container. ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| field_or_fields_container |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| Pin 0| field_or_fields_container |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container), [`string_field`](../../core-concepts/dpf-types.md#string-field), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | +| Pin 1| requested_location |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If input 0 is a mesh or a meshes_container, the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | | +| **Pin 0**| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_fc.md index 07fee46d5d..0ced0b99f2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_fc.md @@ -16,21 +16,21 @@ Creates a new fields container with all the fields corresponding to the label sp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | -| Pin 1| label_space |[`label_space`](./../../core-concepts/dpf-types.md#label-space), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs) | -| Pin 2| collapse_labels |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If set to true (default) the input label space (scoping location) is suppressed from the output fields container, otherwise, label space is kept. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | +| Pin 1| label_space |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs) | +| Pin 2| collapse_labels |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true (default) the input label space (scoping location) is suppressed from the output fields container, otherwise, label space is kept. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields_container | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_mc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_mc.md index 273e650040..71998fdd3a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_mc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_mc.md @@ -16,21 +16,21 @@ Creates a new meshes container with all the meshed regions corresponding to the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| meshes |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | meshes | -| Pin 1| label_space |[`label_space`](./../../core-concepts/dpf-types.md#label-space), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs) | -| Pin 2| collapse_labels |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If set to true (default) the input label space (scoping location) is suppressed from the output meshes container, otherwise, label space is kept. | +| Pin 0
Required| meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | meshes | +| Pin 1| label_space |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs) | +| Pin 2| collapse_labels |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true (default) the input label space (scoping location) is suppressed from the output meshes container, otherwise, label space is kept. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshes_container |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | meshes | +| **Pin 0**| meshes_container |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | meshes | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_sc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_sc.md index 924d2c5861..db2226d95a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_sc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_sub_sc.md @@ -16,21 +16,21 @@ Creates a new scopings container with all the scopings corresponding to the labe | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| scopings_container |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | scopings_container | -| Pin 1| label_space |[`label_space`](./../../core-concepts/dpf-types.md#label-space), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs) | -| Pin 2| collapse_labels |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If set to true (default) the input label space (scoping location) is suppressed from the output scopings container, otherwise, label space is kept. | +| Pin 0
Required| scopings_container |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | scopings_container | +| Pin 1| label_space |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs) | +| Pin 2| collapse_labels |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true (default) the input label space (scoping location) is suppressed from the output scopings container, otherwise, label space is kept. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scopings_container |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | scopings_container | +| **Pin 0**| scopings_container |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | scopings_container | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_time_freq.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_time_freq.md index 750517a9e4..d62466813b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_time_freq.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/extract_time_freq.md @@ -16,21 +16,21 @@ Extract timefreqs with sets scoping from a time freq support | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| real_or_complex |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | False for real only (default). True for complex output. | +| Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | +| Pin 1| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 2| real_or_complex |[`bool`](../../core-concepts/dpf-types.md#standard-types) | False for real only (default). True for complex output. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/fc_get_attribute.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/fc_get_attribute.md index 72fcf4b53c..dbc6b66bbb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/fc_get_attribute.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/fc_get_attribute.md @@ -16,21 +16,21 @@ Uses the FieldsContainer APIs to return a given attribute of the fields containe | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "label_scoping", "label_values", "time_freq_support", "labels", "field_scoping" and "field". | -| Pin 2| property_identifier |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | Additional pin for some property : the label name for "label_scoping" or "label_values", the field index (default 0) for "field_scoping" or "field". | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "label_scoping", "label_values", "time_freq_support", "labels", "field_scoping" and "field". | +| Pin 2| property_identifier |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for some property : the label name for "label_scoping" or "label_values", the field index (default 0) for "field_scoping" or "field". | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`label_space`](./../../core-concepts/dpf-types.md#label-space), [`field`](./../../core-concepts/dpf-types.md#field) | Returns a Scoping for property: "label_scoping", a vector of int for "label_values", a time freq support for "time_freq_support", a vector of string for "labels", a LabelSpace for "field_scoping" and a "field" for "field". | +| **Pin 0**| property |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`label_space`](../../core-concepts/dpf-types.md#label-space), [`field`](../../core-concepts/dpf-types.md#field) | Returns a Scoping for property: "label_scoping", a vector of int for "label_values", a time freq support for "time_freq_support", a vector of string for "labels", a LabelSpace for "field_scoping" and a "field" for "field". | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/field.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field.md new file mode 100644 index 0000000000..e1f67b3320 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field.md @@ -0,0 +1,50 @@ +--- +category: utility +plugin: core +license: None +--- + +# utility:incremental field + +**Version: 0.0.0** + +## Description + +Incrementaly merge the input. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| input |[`field`](../../core-concepts/dpf-types.md#field) | | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| incremented_result | | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: utility + + **Plugin**: core + + **Scripting name**: field + + **Full name**: utility.field + + **Internal name**: incremental::merge::field + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_clone_to_shell_layer.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_clone_to_shell_layer.md index b29f3ead92..5b0ba086b6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_clone_to_shell_layer.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_clone_to_shell_layer.md @@ -16,21 +16,21 @@ Generates a Field from the Field in input 0 that has the same FieldDefinition wi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| shell_layer |[`int32`](./../../core-concepts/dpf-types.md#standard-types), `enum dataProcessing::EShellLayers` | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. | -| Pin 2| duplicate_scoping |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, a new scoping is computed for the output Field. If false, the input Field scoping is used. Default is false. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types), enum dataProcessing::EShellLayers | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | +| Pin 2| duplicate_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, a new scoping is computed for the output Field. If false, the input Field scoping is used. Default is false. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_get_attribute.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_get_attribute.md index d935dd6369..a72e60180a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_get_attribute.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_get_attribute.md @@ -10,26 +10,26 @@ license: None ## Description -A Field in pin 0 and a property name (string) in pin 1 are expected in input. +Gets a property from an input field/field container. A Fieldin pin 0, a property name (string) in pin 1 are expected as inputs ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Accepted inputs are: 'time_freq_support' and 'scoping'. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | Property value. | +| **Pin 0**| property |[`string`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_to_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_to_fc.md index b73d2e724a..b294d127dc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_to_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_to_fc.md @@ -16,20 +16,20 @@ Creates a fields container containing the field provided on pin 0. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | If a fields container is set in input, it is passed on as an output with the additional label space (if any). | -| Pin 1
Required| label |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | Sets a label space. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | If a fields container is set in input, it is passed on as an output with the additional label space (if any). | +| Pin 1
Required| label |[`label_space`](../../core-concepts/dpf-types.md#label-space) | Sets a label space. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/fields_container.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/fields_container.md new file mode 100644 index 0000000000..40c43349e5 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/fields_container.md @@ -0,0 +1,50 @@ +--- +category: utility +plugin: core +license: None +--- + +# utility:incremental fields container + +**Version: 0.0.0** + +## Description + +Incrementaly merge the input. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| input |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| incremented_result | | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: utility + + **Plugin**: core + + **Scripting name**: fields_container + + **Full name**: utility.fields_container + + **Internal name**: incremental::merge::fields_container + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/for_each.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/for_each.md index b9ceee9e73..e034ab78de 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/for_each.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/for_each.md @@ -18,7 +18,7 @@ Allows to write a loop over a chunk of operators. |-------|-------|------------------|-------------| | Pin 0
Required| iterable | | Either the result of the make_iterable_info operator, or the operator that must be incremented. | | Pin 1| iterable_values | | | -| Pin 2| pin_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3
Required| forward | | | ## Outputs @@ -32,8 +32,8 @@ Allows to write a loop over a chunk of operators. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **evaluate_inputs_before_run** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | 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`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **evaluate_inputs_before_run** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | 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`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward.md index eb8c1a8de4..eb407a3127 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward.md @@ -16,20 +16,20 @@ Return all the inputs as outputs. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| any |[`any`](./../../core-concepts/dpf-types.md#any) | any type of input | +| Pin 0
Required| any |[`any`](../../core-concepts/dpf-types.md#any) | any type of input | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| any |[`any`](./../../core-concepts/dpf-types.md#any) | same types as inputs | +| **Pin 0**| any |[`any`](../../core-concepts/dpf-types.md#any) | same types as inputs | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_field.md index 051ecb4f7d..07d600713b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_field.md @@ -16,19 +16,19 @@ Returns the input field or fields container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_fields_container.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_fields_container.md index e60cffa0ac..132ccc4f7b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_fields_container.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_fields_container.md @@ -16,19 +16,19 @@ Returns the input field or fields container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0
Required| fields |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_meshes_container.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_meshes_container.md index a28a7c8a47..286bba0394 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_meshes_container.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/forward_meshes_container.md @@ -16,20 +16,20 @@ Returns the input mesh or meshes container into a meshes container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| meshes |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container), [`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1| default_label |[`string`](./../../core-concepts/dpf-types.md#standard-types) | this default label is used if a new meshes container needs to be created (default is unknown) | +| Pin 0
Required| meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | +| Pin 1| default_label |[`string`](../../core-concepts/dpf-types.md#standard-types) | this default label is used if a new meshes container needs to be created (default is unknown) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshes_container |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| meshes_container |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/hdf5dpf_workglow_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/hdf5dpf_workglow_provider.md index 586f547492..1348fd887a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/hdf5dpf_workglow_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/hdf5dpf_workglow_provider.md @@ -16,24 +16,24 @@ Extract a custom result from an hdf5dpf file as an executable workflow. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 1| mesh_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 3| streams |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | Hdf5df file stream. | -| Pin 4| data_sources |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | Hdf5df file data source. | -| Pin 24| meta_data |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | meta_data that may be used to evaluate results or extract workflows. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Hdf5df file stream. | +| Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Hdf5df file data source. | +| Pin 24| meta_data |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | meta_data that may be used to evaluate results or extract workflows. | | Pin 60
Required| result_name | | Name of the result that must be extracted from the hdf5dpf file | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field_or_fields_container |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | | +| **Pin 0**| field_or_fields_container |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/html_doc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/html_doc.md index 2931553cb5..197b1bc9c1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/html_doc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/html_doc.md @@ -16,8 +16,8 @@ Create dpf's html documentation. Only on Windows. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| output_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | default is {working directory}/dataProcessingDoc.html | -| Pin 1| exposure_level |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Generate the documentation depending on exposure level : 0 (default) for public operators, 1 includes hidden operator, 2 includes private operator, 3 includes operator without specifications. | +| Pin 0| output_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | default is {working directory}/dataProcessingDoc.html | +| Pin 1| exposure_level |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Generate the documentation depending on exposure level : 0 (default) for public operators, 1 includes hidden operator, 2 includes private operator, 3 includes operator without specifications. | ## Outputs @@ -28,7 +28,7 @@ Create dpf's html documentation. Only on Windows. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/incremental_concatenate_as_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/incremental_concatenate_as_fc.md index f090b4b8b4..0a65fcd0ef 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/incremental_concatenate_as_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/incremental_concatenate_as_fc.md @@ -16,20 +16,20 @@ Assemble fields in a fields container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1| label |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | Label space value that must be applied to the added field. | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1| label |[`label_space`](../../core-concepts/dpf-types.md#label-space) | Label space value that must be applied to the added field. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| output |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/ints_to_scoping.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/ints_to_scoping.md index b931091360..0d578bbc6a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/ints_to_scoping.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/ints_to_scoping.md @@ -16,20 +16,20 @@ take a int or a vector of int and transform it in a one entity field of location | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| int_or_vector_int |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | int or vector of int | -| Pin 1| location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| int_or_vector_int |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | int or vector of int | +| Pin 1| location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_for_each_range.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_for_each_range.md index 1a7acdf150..d942c05e02 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_for_each_range.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_for_each_range.md @@ -16,10 +16,10 @@ Generate a range that can be consumed by the for_each operator | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1| try_generate_iterable |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) | +| Pin -1| try_generate_iterable |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) | | Pin 0| iterable | | Iterable object, generated by make_for_each_range oeprator, that can be combined with the one currently generated. | -| Pin 1
Required| operator_to_iterate |[`operator`](./../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3
Required| valueA | | | | Pin 4
Required| valueB | | | | Pin 5
Required| valueC | | | @@ -34,7 +34,7 @@ Generate a range that can be consumed by the for_each operator | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_label_space.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_label_space.md index 80bd5a4ed6..682dba058d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_label_space.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_label_space.md @@ -16,21 +16,21 @@ Assemble strings and integers to make a label space. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| base_label |[`label_space`](./../../core-concepts/dpf-types.md#label-space), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | Used as a base label (extracted from Fields/Scoping Container, or directly from Label Space) that is concatenated with provided values. | -| Pin 1
Required| label_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2
Required| label_value |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0| base_label |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Used as a base label (extracted from Fields/Scoping Container, or directly from Label Space) that is concatenated with provided values. | +| Pin 1
Required| label_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2
Required| label_value |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| label |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | | +| **Pin 0**| label |[`label_space`](../../core-concepts/dpf-types.md#label-space) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_overall.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_overall.md index 2b9e89a976..dd7088ef74 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_overall.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_overall.md @@ -16,20 +16,20 @@ Extracts a value from a field and makes a new field containing only this value, | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1
Required| id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_producer_consumer_for_each_iterator.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_producer_consumer_for_each_iterator.md index 1e12dee65c..193693ad6d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_producer_consumer_for_each_iterator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/make_producer_consumer_for_each_iterator.md @@ -16,17 +16,17 @@ Generates an iterator that can be consumed by the for_each operator.The chain of | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1| try_generate_iterable |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) | +| Pin -1| try_generate_iterable |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) | | Pin 0| iterable | | Iterable object, generated by make_for_each_range oeprator, that can be combined with the one currently generated. | -| Pin 1
Required| operator_to_iterate |[`operator`](./../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3
Required| valueA | | | | Pin 4
Required| valueB | | | | Pin 5
Required| valueC | | | -| Pin 1000
Required| producer_op1 |[`operator`](./../../core-concepts/dpf-types.md#operator) | | -| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1003
Required| consumer_op1 |[`operator`](./../../core-concepts/dpf-types.md#operator) | | +| Pin 1000
Required| producer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | +| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1003
Required| consumer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | ## Outputs @@ -38,7 +38,7 @@ Generates an iterator that can be consumed by the for_each operator.The chain of | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/mechanical_make_time_chunk_for_each.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/mechanical_make_time_chunk_for_each.md index 913727ccec..7b1092a308 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/mechanical_make_time_chunk_for_each.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/mechanical_make_time_chunk_for_each.md @@ -16,15 +16,15 @@ Splits a list of time/freq values into chunks depending on evaluated result prop | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| target_time_freq_values |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types) | List of time/freq values to potentially split in chunks. | -| Pin 1
Required| operator_to_iterate |[`operator`](./../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 7
Required| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | The number of nodes (for "Nodal" results) or number of elements (for "Elemental" results) is used to compute the chunk. | -| Pin 200
Required| chunk_config |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | a data tree with an int attribute "max_num_bytes", an int attribute "dimensionality" (average result size by entity), a string attribute "location" ("Nodal" or"Elemental") is expected. | -| Pin 1000
Required| producer_op1 |[`operator`](./../../core-concepts/dpf-types.md#operator) | | -| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1003
Required| consumer_op1 |[`operator`](./../../core-concepts/dpf-types.md#operator) | | +| Pin 0
Required| target_time_freq_values |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | List of time/freq values to potentially split in chunks. | +| Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 7
Required| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The number of nodes (for "Nodal" results) or number of elements (for "Elemental" results) is used to compute the chunk. | +| Pin 200
Required| chunk_config |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | a data tree with an int attribute "max_num_bytes", an int attribute "dimensionality" (average result size by entity), a string attribute "location" ("Nodal" or"Elemental") is expected. | +| Pin 1000
Required| producer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | +| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1003
Required| consumer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | ## Outputs @@ -36,7 +36,7 @@ Splits a list of time/freq values into chunks depending on evaluated result prop | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md index 661270c4d4..6c68ab92ee 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md @@ -16,15 +16,15 @@ Splits a time freq support into chunks depending on evaluated result properties, | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| target_time_freq_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | List of time freq support to potentially split in chunks. | -| Pin 1
Required| operator_to_iterate |[`operator`](./../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 7
Required| abstract_meshed_region |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`field`](./../../core-concepts/dpf-types.md#field) | When a mesh is provided, the number of nodes (for "Nodal" results) or number of elements (for "Elemental" results) is used to compute the chunk. When a field is provided, its scoping size is used to compute the chunk. | -| Pin 200
Required| chunk_config |[`abstract_data_tree`](./../../core-concepts/dpf-types.md#data-tree) | a data tree with an int attribute "max_num_bytes", an int attribute "dimensionality" (average result size by entity), a string attribute "location" ("Nodal" or"Elemental") is expected. | -| Pin 1000
Required| producer_op1 |[`operator`](./../../core-concepts/dpf-types.md#operator) | | -| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1003
Required| consumer_op1 |[`operator`](./../../core-concepts/dpf-types.md#operator) | | +| Pin 0
Required| target_time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | List of time freq support to potentially split in chunks. | +| Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 7
Required| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | When a mesh is provided, the number of nodes (for "Nodal" results) or number of elements (for "Elemental" results) is used to compute the chunk. When a field is provided, its scoping size is used to compute the chunk. | +| Pin 200
Required| chunk_config |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | a data tree with an int attribute "max_num_bytes", an int attribute "dimensionality" (average result size by entity), a string attribute "location" ("Nodal" or"Elemental") is expected. | +| Pin 1000
Required| producer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | +| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1003
Required| consumer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | ## Outputs @@ -36,7 +36,7 @@ Splits a time freq support into chunks depending on evaluated result properties, | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_any.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_any.md index 4a65c57bea..636b7bfe79 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_any.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_any.md @@ -16,20 +16,20 @@ Merges a list of objects having the same data types. Once the data type is found | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| any |[`any`](./../../core-concepts/dpf-types.md#any) | Either a vector of objects (sharing the same data types) or objects from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. | +| Pin 0
Required| any |[`any`](../../core-concepts/dpf-types.md#any) | Either a vector of objects (sharing the same data types) or objects from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| any |[`any`](./../../core-concepts/dpf-types.md#any) | | +| **Pin 0**| any |[`any`](../../core-concepts/dpf-types.md#any) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_collections.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_collections.md index f5f20affab..b05a4990b7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_collections.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_collections.md @@ -16,20 +16,20 @@ Merges a set of collections into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| collections |`vector>`, [`any_collection`](./../../core-concepts/dpf-types.md#any-collection) | a vector of collections to merge or collections from pin 0 to ... | +| Pin 0
Required| collections |vector>, [`any_collection`](../../core-concepts/dpf-types.md#any-collection) | a vector of collections to merge or collections from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_collections |[`any_collection`](./../../core-concepts/dpf-types.md#any-collection) | | +| **Pin 0**| merged_collections |[`any_collection`](../../core-concepts/dpf-types.md#any-collection) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_data_tree.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_data_tree.md index fd5bc11ff1..3c30ecfbd9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_data_tree.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_data_tree.md @@ -16,20 +16,20 @@ Merges a list of data trees. Attributes names shouldn't be shared accross data t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| data_tree |[`data_tree`](./../../core-concepts/dpf-types.md#data-tree), `vector>` | Either a vector of data trees or data trees from pin 0 to ... to merge. | +| Pin 0
Required| data_tree |[`data_tree`](../../core-concepts/dpf-types.md#data-tree), vector> | Either a vector of data trees or data trees from pin 0 to ... to merge. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| any |[`any`](./../../core-concepts/dpf-types.md#any) | | +| **Pin 0**| any |[`any`](../../core-concepts/dpf-types.md#any) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields.md index 10fca45d31..45da359af3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields.md @@ -16,22 +16,22 @@ Assembles a set of fields into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -2| sum_merge |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin -1| merged_support |`abstract_field_support` | Already merged field support. | -| Pin 0
Required| fields |`vector>`, [`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | +| Pin -2| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin -1| merged_support |abstract_field_support | Already merged field support. | +| Pin 0
Required| fields |vector>, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| merged_field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_by_label.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_by_label.md index 4bd1daac06..9760cda530 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_by_label.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_by_label.md @@ -16,23 +16,23 @@ Merges the fields of a fields container that share the same label value. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| label |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Label identifier that should be merged. | -| Pin 2| merged_field_support |`abstract_field_support` | The FieldsContainer's support that has already been merged. | -| Pin 3| sum_merge |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label identifier that should be merged. | +| Pin 2| merged_field_support |abstract_field_support | The FieldsContainer's support that has already been merged. | +| Pin 3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| merged_field_support |`abstract_field_support` | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 1**| merged_field_support |abstract_field_support | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_container_matrices_label.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_container_matrices_label.md index e05e7c6f2e..f928023f5c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_container_matrices_label.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_container_matrices_label.md @@ -16,21 +16,21 @@ Merge fields of fields container into field matrices. The output is a fields con | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields container to be merged | -| Pin 1
Required| label |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Label where the merge is required | -| Pin 2| time_scoping |[`int32`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types), [`scoping`](./../../core-concepts/dpf-types.md#scoping) | if it's specified, fields container of field matrices is constructed only on the specified time scoping | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields container to be merged | +| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label where the merge is required | +| Pin 2| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | if it's specified, fields container of field matrices is constructed only on the specified time scoping | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | fields container of field matrices obtained after merging. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields container of field matrices obtained after merging. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_containers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_containers.md index b133c9ce8e..c6e2bee658 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_containers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_containers.md @@ -16,24 +16,24 @@ Assembles a set of fields containers into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -200| should_merge_named_selections |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | -| Pin -3| sum_merge |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin -2| merged_fields_support |`abstract_field_support` | Already merged field support. | -| Pin -1| merged_fields_containers_support |`abstract_field_support`, `umap>` | Already merged fields containers support. | -| Pin 0
Required| fields_containers |`vector>`, [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | +| Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | +| Pin -3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin -2| merged_fields_support |abstract_field_support | Already merged field support. | +| Pin -1| merged_fields_containers_support |abstract_field_support, umap> | Already merged fields containers support. | +| Pin 0
Required| fields_containers |vector>, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| merged_fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_generic_data_container.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_generic_data_container.md index 4af7876ae0..26e7fce5f8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_generic_data_container.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_generic_data_container.md @@ -16,19 +16,19 @@ Merges a list of generic data container. For each data entry, the merge operatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| generic_data_container |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container), `vector>` | Either a vector of generic data containers (sharing the same data types) or generic data containers from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. | +| Pin 0
Required| generic_data_container |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container), vector> | Either a vector of generic data containers (sharing the same data types) or generic data containers from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| generic_data_container |[`generic_data_container`](./../../core-concepts/dpf-types.md#generic-data-container) | | +| **Pin 0**| generic_data_container |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_materials.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_materials.md index aa7e754b99..b402d4ec17 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_materials.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_materials.md @@ -16,19 +16,19 @@ Assembles a set of materials into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| materials |`vector>`, `materials` | A vector of materials to merge or materials from pin 0 to ... | +| Pin 0
Required| materials |vector>, materials | A vector of materials to merge or materials from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_materials |`materials` | | +| **Pin 0**| merged_materials |materials | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes.md index 302356ee49..c7f0c69207 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes.md @@ -16,25 +16,25 @@ Take a set of meshes and assemble them in a unique one | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -201| naive_merge_elements |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, merge the elemental Property Fields of the input meshes assuming that there is no repetition in their scoping ids. Default is false. | -| Pin -200| should_merge_named_selections |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For certain types of files (such as RST), scoping from names selection does not need to be merged.If this pin is true, the merge occurs. If this pin is false, the merge does not occur. Default is true. | -| Pin 0
Required| meshes |`vector>`, [`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | A vector of meshed region to merge or meshed region from pin 0 to ... | -| Pin 101| merge_method |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0: merge by distance, 1: merge by node id (default) | -| Pin 102| box_size |[`double`](./../../core-concepts/dpf-types.md#standard-types) | Box size used when merging by distance. Default value is 1e-12. | -| Pin 103| remove_duplicate_elements |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0: keep duplicate elements (default), 1: remove duplicate elements | +| Pin -201| naive_merge_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, merge the elemental Property Fields of the input meshes assuming that there is no repetition in their scoping ids. Default is false. | +| Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For certain types of files (such as RST), scoping from names selection does not need to be merged.If this pin is true, the merge occurs. If this pin is false, the merge does not occur. Default is true. | +| Pin 0
Required| meshes |vector>, [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | A vector of meshed region to merge or meshed region from pin 0 to ... | +| Pin 101| merge_method |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: merge by distance, 1: merge by node id (default) | +| Pin 102| box_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | Box size used when merging by distance. Default value is 1e-12. | +| Pin 103| remove_duplicate_elements |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: keep duplicate elements (default), 1: remove duplicate elements | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merges_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | | +| **Pin 0**| merges_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes_containers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes_containers.md index 1047405785..7ad089d909 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes_containers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes_containers.md @@ -16,20 +16,20 @@ Assembles a set of meshes containers into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| meshes_containers |`vector>`, [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | a vector of meshes containers to merge or meshes containers from pin 0 to ... | +| Pin 0
Required| meshes_containers |vector>, [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | a vector of meshes containers to merge or meshes containers from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_meshes_container |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| merged_meshes_container |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_property_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_property_fields.md index 4652477b4c..3fd678f068 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_property_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_property_fields.md @@ -16,20 +16,20 @@ Assembles a set of property fields into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -201
Required| naive_merge |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, merge the input property fields assuming that there is no repetition in their scoping ids. Default is false. | -| Pin 0
Required| property_fields |`vector>`, [`property_field`](./../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](./../../core-concepts/dpf-types.md#property-fields-container) | Either a property fields container, a vector of property fields to merge or property fields from pin 0 to ... | +| Pin -201
Required| naive_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, merge the input property fields assuming that there is no repetition in their scoping ids. Default is false. | +| Pin 0
Required| property_fields |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | Either a property fields container, a vector of property fields to merge or property fields from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property_field |[`property_field`](./../../core-concepts/dpf-types.md#property-field) | | +| **Pin 0**| property_field |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_result_infos.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_result_infos.md index a1f9619b02..51c33d82d5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_result_infos.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_result_infos.md @@ -16,20 +16,20 @@ Assembles a set of result information into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| result_infos |`vector>`, [`result_info`](./../../core-concepts/dpf-types.md#result-info) | A vector of result info containers to merge or result infos from pin 0 to ... | +| Pin 0
Required| result_infos |vector>, [`result_info`](../../core-concepts/dpf-types.md#result-info) | A vector of result info containers to merge or result infos from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_result_infos |[`result_info`](./../../core-concepts/dpf-types.md#result-info) | | +| **Pin 0**| merged_result_infos |[`result_info`](../../core-concepts/dpf-types.md#result-info) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings.md index 601424958f..54d3c32e1e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings.md @@ -16,19 +16,19 @@ Assembles a set of scopings into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| scopings |[`scoping`](./../../core-concepts/dpf-types.md#scoping), [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container), `vector>` | Either a scopings container, a vector of scopings to merge, or scopings from pin 0 to ... | +| Pin 0
Required| scopings |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), vector> | Either a scopings container, a vector of scopings to merge, or scopings from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | +| **Pin 0**| merged_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings_containers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings_containers.md index 4ca9bfe97f..291d7f1145 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings_containers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings_containers.md @@ -16,19 +16,19 @@ Assembles a set of scopings containers into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| scopings_containers |`vector>`, [`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | A vector of scopings containers to merge or scopings containers from pin 0 to ... | +| Pin 0
Required| scopings_containers |vector>, [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | A vector of scopings containers to merge or scopings containers from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_scopings_container |[`scopings_container`](./../../core-concepts/dpf-types.md#scopings-container) | | +| **Pin 0**| merged_scopings_container |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_string_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_string_fields.md index 35145c00f7..23d82acbba 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_string_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_string_fields.md @@ -16,19 +16,19 @@ Assembles a set of string fields into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| string_fields |`vector>`, [`string_field`](./../../core-concepts/dpf-types.md#string-field) | Either a a vector of string fields to merge or string fields from pin 0 to ... | +| Pin 0
Required| string_fields |vector>, [`string_field`](../../core-concepts/dpf-types.md#string-field) | Either a a vector of string fields to merge or string fields from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| string_field |[`string_field`](./../../core-concepts/dpf-types.md#string-field) | | +| **Pin 0**| string_field |[`string_field`](../../core-concepts/dpf-types.md#string-field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_supports.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_supports.md index bd8da03394..3191db4861 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_supports.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_supports.md @@ -16,20 +16,20 @@ Assembles a set of supports into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -200| should_merge_named_selections |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | -| Pin 0
Required| supports |`vector>`, `abstract_field_support` | A vector of supports to merge or supports from pin 0 to ... | +| Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | +| Pin 0
Required| supports |vector>, abstract_field_support | A vector of supports to merge or supports from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_support |`abstract_field_support` | | +| **Pin 0**| merged_support |abstract_field_support | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_time_freq_supports.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_time_freq_supports.md index fbd2c6ec16..d415308bdb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_time_freq_supports.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_time_freq_supports.md @@ -16,19 +16,19 @@ Assembles a set of time/frequency supports into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_supports |`vector>`, [`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | A vector of time/frequency supports to merge or time/frequency supports from pin 0 to ... | +| Pin 0
Required| time_freq_supports |vector>, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | A vector of time/frequency supports to merge or time/frequency supports from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_support |[`time_freq_support`](./../../core-concepts/dpf-types.md#time-freq-support) | | +| **Pin 0**| merged_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_to_field_matrix.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_to_field_matrix.md index fa018e364a..72a72cce61 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_to_field_matrix.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_to_field_matrix.md @@ -16,19 +16,19 @@ Assembles a set of fields into a field matrix. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields |`vector>`, [`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | +| Pin 0
Required| fields |vector>, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_field_matrix |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| merged_field_matrix |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields.md index cfd67fb6d9..21fb16ddda 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields.md @@ -16,22 +16,22 @@ Assembles a set of fields into a unique one, applying a weight on the sum of the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -2| sum_merge |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin -1| merged_support |`abstract_field_support` | Already merged field support. | -| Pin 0
Required| fields |`vector>`, [`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | -| Pin 1000
Required| weights |`vector>`, [`property_field`](./../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | +| Pin -2| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin -1| merged_support |abstract_field_support | Already merged field support. | +| Pin 0
Required| fields |vector>, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | +| Pin 1000
Required| weights |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`property_field`](../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| merged_field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields_containers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields_containers.md index b5d73fc5b2..31a738d3ad 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields_containers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields_containers.md @@ -16,24 +16,24 @@ Assembles a set of fields containers into a unique one, applying a weight on the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -3| sum_merge |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin -2| merged_fields_support |`abstract_field_support` | Already merged field support. | -| Pin -1| merged_fields_containers_support |`abstract_field_support`, `umap>` | Already merged fields containers support. | -| Pin 0
Required| fields_containers |`vector>`, [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | -| Pin 1000
Required| weights |`vector>>`, `class dataProcessing::DpfTypeCollection` | Weights to apply to each field from pin 1000 to ... | +| Pin -3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin -2| merged_fields_support |abstract_field_support | Already merged field support. | +| Pin -1| merged_fields_containers_support |abstract_field_support, umap> | Already merged fields containers support. | +| Pin 0
Required| fields_containers |vector>, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | +| Pin 1000
Required| weights |vector>>, class dataProcessing::DpfTypeCollection | Weights to apply to each field from pin 1000 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| merged_fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/mesh.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/mesh.md new file mode 100644 index 0000000000..9737295ce3 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/mesh.md @@ -0,0 +1,50 @@ +--- +category: utility +plugin: core +license: None +--- + +# utility:incremental mesh + +**Version: 0.0.0** + +## Description + +Incrementaly merge the input. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| input |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| incremented_result | | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: utility + + **Plugin**: core + + **Scripting name**: mesh + + **Full name**: utility.mesh + + **Internal name**: incremental::merge::mesh + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/mesh_to_mc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/mesh_to_mc.md index 2a2a88e754..ce3f12f693 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/mesh_to_mc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/mesh_to_mc.md @@ -16,20 +16,20 @@ Creates a meshes container containing the mesh provided on pin 0. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | If a meshes container is set in input, it is passed on as an output with the additional label space (if any). | -| Pin 1
Required| label |[`label_space`](./../../core-concepts/dpf-types.md#label-space) | Sets a label space. | +| Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | If a meshes container is set in input, it is passed on as an output with the additional label space (if any). | +| Pin 1
Required| label |[`label_space`](../../core-concepts/dpf-types.md#label-space) | Sets a label space. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| meshes_container |[`meshes_container`](./../../core-concepts/dpf-types.md#meshes-container) | | +| **Pin 0**| meshes_container |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/meshes_container.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/meshes_container.md new file mode 100644 index 0000000000..60d5796236 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/meshes_container.md @@ -0,0 +1,50 @@ +--- +category: utility +plugin: core +license: None +--- + +# utility:incremental meshes container + +**Version: 0.0.0** + +## Description + +Incrementaly merge the input. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| input |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| incremented_result | | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: utility + + **Plugin**: core + + **Scripting name**: meshes_container + + **Full name**: utility.meshes_container + + **Internal name**: incremental::merge::meshes_container + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/operator_changelog.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/operator_changelog.md new file mode 100644 index 0000000000..b8613b9273 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/operator_changelog.md @@ -0,0 +1,50 @@ +--- +category: utility +plugin: core +license: None +--- + +# utility:operator changelog + +**Version: 0.0.0** + +## Description + +Return a GenericDataContainer used to instantiate the Changelog of an operator based on its name. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| operator_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Operator internal name. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| changelog_gdc |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | GenericDataContainer used to instantiate a Changelog. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: utility + + **Plugin**: core + + **Scripting name**: operator_changelog + + **Full name**: utility.operator_changelog + + **Internal name**: operator_changelog + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/operator_id.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/operator_id.md index 71205a12c3..47afe57b98 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/operator_id.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/operator_id.md @@ -16,19 +16,19 @@ Return the id of an Operator. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| op |[`operator`](./../../core-concepts/dpf-types.md#operator) | | +| Pin 0
Required| op |[`operator`](../../core-concepts/dpf-types.md#operator) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 0**| id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/overlap_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/overlap_fields.md index 59ab8cb27a..1818238e49 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/overlap_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/overlap_fields.md @@ -16,20 +16,20 @@ Take two fields and superpose them, the overlapping field will override values o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| base_field |[`field`](./../../core-concepts/dpf-types.md#field) | | -| Pin 1| overlapping_field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| Pin 0| base_field |[`field`](../../core-concepts/dpf-types.md#field) | | +| Pin 1| overlapping_field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/producer_consumer_for_each.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/producer_consumer_for_each.md index 19e7bdbeec..bd719d4dc7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/producer_consumer_for_each.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/producer_consumer_for_each.md @@ -30,8 +30,8 @@ Allows to write a loop over operators by connecting data to iterate and by reque | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **evaluate_inputs_before_run** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | 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`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **evaluate_inputs_before_run** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | 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`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/property_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/property_field.md new file mode 100644 index 0000000000..a0d007b244 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/property_field.md @@ -0,0 +1,50 @@ +--- +category: utility +plugin: core +license: None +--- + +# utility:incremental property field + +**Version: 0.0.0** + +## Description + +Incrementaly merge the input. + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| input |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| incremented_result | | | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: utility + + **Plugin**: core + + **Scripting name**: property_field + + **Full name**: utility.property_field + + **Internal name**: incremental::merge::property_field + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/propertyfield_get_attribute.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/propertyfield_get_attribute.md new file mode 100644 index 0000000000..67c688b541 --- /dev/null +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/propertyfield_get_attribute.md @@ -0,0 +1,51 @@ +--- +category: utility +plugin: core +license: None +--- + +# utility:property field get attribute + +**Version: 0.0.0** + +## Description + +Gets a property from an input field/field container. A PropertyFieldin pin 0, a property name (string) in pin 1 are expected as inputs + +## Inputs + +| Input | Name | Expected type(s) | Description | +|-------|-------|------------------|-------------| +| Pin 0
Required| property_field |[`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'. | + +## Outputs + +| Output | Name | Expected type(s) | Description | +|-------|------|------------------|-------------| +| **Pin 0**| property |[`string`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers. | + +## Configurations + +| Name| Expected type(s) | Default value | Description | +|-----|------|----------|-------------| +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | + +## Scripting + + **Category**: utility + + **Plugin**: core + + **Scripting name**: propertyfield_get_attribute + + **Full name**: utility.propertyfield_get_attribute + + **Internal name**: propertyfield::get_attribute + + **License**: None + + +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/python_generator.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/python_generator.md index ae4440e879..219915705d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/python_generator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/python_generator.md @@ -16,10 +16,10 @@ Generates .py file with specifications for loaded plugin(s). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| dll_source_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 1
Required| output_path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 2| load_symbol |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 3| library_key |[`string`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 0
Required| dll_source_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| output_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| load_symbol |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 3| library_key |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -30,7 +30,7 @@ Generates .py file with specifications for loaded plugin(s). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/remote_operator_instantiate.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/remote_operator_instantiate.md index 2d54092510..d83705c895 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/remote_operator_instantiate.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/remote_operator_instantiate.md @@ -16,25 +16,25 @@ Create a local image of an existing remote operator (identified by an id and an | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| operator_to_send |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | local workflow to push to a remote or id of a remote workflow | -| Pin 1
Required| output_pin |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | pin number of the output to name | -| Pin 3
Required| streams_to_remote |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4| data_sources_to_remote |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5
Required| output_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | output's name of the workflow to return | +| Pin 0
Required| operator_to_send |[`int32`](../../core-concepts/dpf-types.md#standard-types) | local workflow to push to a remote or id of a remote workflow | +| Pin 1
Required| output_pin |[`int32`](../../core-concepts/dpf-types.md#standard-types) | pin number of the output to name | +| Pin 3
Required| streams_to_remote |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4| data_sources_to_remote |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 5
Required| output_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | output's name of the workflow to return | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| remote_workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | remote workflow containing an image of the remote workflow and the protocols streams | +| **Pin 0**| remote_workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | remote workflow containing an image of the remote workflow and the protocols streams | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/remote_workflow_instantiate.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/remote_workflow_instantiate.md index 5644deead7..9ab47b7e95 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/remote_workflow_instantiate.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/remote_workflow_instantiate.md @@ -16,23 +16,23 @@ Sends a local workflow to a remote process (and keep a local image of it) or cre | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| workflow_to_send |[`workflow`](./../../core-concepts/dpf-types.md#workflow), [`int32`](./../../core-concepts/dpf-types.md#standard-types) | local workflow to push to a remote or id of a remote workflow | -| Pin 3
Required| streams_to_remote |[`streams_container`](./../../core-concepts/dpf-types.md#streams-container) | | -| Pin 4| data_sources_to_remote |[`data_sources`](./../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0
Required| workflow_to_send |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`int32`](../../core-concepts/dpf-types.md#standard-types) | local workflow to push to a remote or id of a remote workflow | +| Pin 3
Required| streams_to_remote |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | +| Pin 4| data_sources_to_remote |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| remote_workflow |[`workflow`](./../../core-concepts/dpf-types.md#workflow) | remote workflow containing an image of the remote workflow and the protocols streams | +| **Pin 0**| remote_workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | remote workflow containing an image of the remote workflow and the protocols streams | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/remove_unnecessary_labels.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/remove_unnecessary_labels.md index b88f420984..ee74964f29 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/remove_unnecessary_labels.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/remove_unnecessary_labels.md @@ -16,22 +16,22 @@ Removes the selected label from a fields container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1| permissive |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | If true, the operator does not throw an error if the label to be removed has more than one entry. | -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Fields Container with the label to be removed. | -| Pin 1
Required| label_to_remove |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Label to be removed from the fields container. | +| Pin -1| permissive |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the operator does not throw an error if the label to be removed has more than one entry. | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container with the label to be removed. | +| Pin 1
Required| label_to_remove |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label to be removed from the fields container. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/scalars_to_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/scalars_to_field.md index 48c585517c..d8aa9fd7dc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/scalars_to_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/scalars_to_field.md @@ -16,24 +16,24 @@ Create scalar or vector Field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| double_or_vector_double |[`double`](./../../core-concepts/dpf-types.md#standard-types), [`vector`](./../../core-concepts/dpf-types.md#standard-types) | Data of the field, default is 0-field. Specify a double to have a field of same value or specify directly the data vector. | -| Pin 1| unit |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Unit symbol (m, Hz, kg, ...) | -| Pin 2| location |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Location of the field ex 'Nodal', 'ElementalNodal', 'Elemental'... Default is 'numeric'. | -| Pin 3| num_entity |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Number of field entities. Default is 1 or the size of the scoping in input if specified. | -| Pin 4| num_comp |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Number of field components. Default is 1. | -| Pin 5| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Scoping. | +| Pin 0| double_or_vector_double |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Data of the field, default is 0-field. Specify a double to have a field of same value or specify directly the data vector. | +| Pin 1| unit |[`string`](../../core-concepts/dpf-types.md#standard-types) | Unit symbol (m, Hz, kg, ...) | +| Pin 2| location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Location of the field ex 'Nodal', 'ElementalNodal', 'Elemental'... Default is 'numeric'. | +| Pin 3| num_entity |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of field entities. Default is 1 or the size of the scoping in input if specified. | +| Pin 4| num_comp |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of field components. Default is 1. | +| Pin 5| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/server_path.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/server_path.md index c460cb2cb9..2b956ddfca 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/server_path.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/server_path.md @@ -16,19 +16,19 @@ Returns the platform-specific path to a folder in the Dpf server | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| subpath |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Subpath of the Dpf server. Supported values: 0 (default): root of the server, 1: "dpf/bin/platform", 2: "aisol/bin(dll)/platform", 3: "dpf/plugins", 4: "dpf/workflows". | +| Pin 0| subpath |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Subpath of the Dpf server. Supported values: 0 (default): root of the server, 1: "dpf/bin/platform", 2: "aisol/bin(dll)/platform", 3: "dpf/plugins", 4: "dpf/workflows". | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| path |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Path to the requested folder in the Dpf server | +| **Pin 0**| path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the requested folder in the Dpf server | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/set_attribute.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/set_attribute.md index 8f4c09b379..0cf8a2f98b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/set_attribute.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/set_attribute.md @@ -16,21 +16,21 @@ Uses the FieldsContainer APIs to modify it. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "labels". | -| Pin 2| property_identifier |[`vector`](./../../core-concepts/dpf-types.md#standard-types), [`label_space`](./../../core-concepts/dpf-types.md#label-space) | Value of the property to be set : vector of string or LabelSpace for "labels". | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "labels". | +| Pin 2| property_identifier |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`label_space`](../../core-concepts/dpf-types.md#label-space) | Value of the property to be set : vector of string or LabelSpace for "labels". | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Returns the modified FieldsContainer. | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Returns the modified FieldsContainer. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/set_property.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/set_property.md index 2868d8767b..350df0c247 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/set_property.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/set_property.md @@ -4,33 +4,33 @@ plugin: core license: None --- -# utility:set property +# utility:field set property **Version: 0.0.0** ## Description -Sets a property to an input field/field container. +Sets a property to an input field/field container. A Fieldin pin 0, a property name (string) in pin 1 and a valid property value in pin 2 are expected as inputs ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| property_name |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Property to set | -| Pin 2
Required| property_value |[`string`](./../../core-concepts/dpf-types.md#standard-types), [`int32`](./../../core-concepts/dpf-types.md#standard-types), [`double`](./../../core-concepts/dpf-types.md#standard-types) | Property to set | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Property to set. Accepted inputs are specific strings namely: 'unit', 'name', 'time_freq_support', 'scoping', 'header'. | +| Pin 2
Required| property |[`string`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | Property Value to set. Accepted inputs on this pin are: CTimeFreqSupport, CScoping, DataTree, int, double, string. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/split_in_for_each_range.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/split_in_for_each_range.md index d45e0402bc..a1afee589f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/split_in_for_each_range.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/split_in_for_each_range.md @@ -17,10 +17,10 @@ Split a scoping into several pieces so you can iterate it with a for_each loop. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0| iterable | | Iterable that can be combined with the one currently generated. | -| Pin 1
Required| operator_to_iterate |[`operator`](./../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | -| Pin 3
Required| scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | | -| Pin 4
Required| chunk_size |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 3
Required| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | +| Pin 4
Required| chunk_size |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -32,7 +32,7 @@ Split a scoping into several pieces so you can iterate it with a for_each loop. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/strain_from_voigt.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/strain_from_voigt.md index cb1f532bc5..ea9627b057 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/strain_from_voigt.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/strain_from_voigt.md @@ -16,19 +16,19 @@ Converts the strain field from Voigt notation into standard format. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/strain_from_voigt_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/strain_from_voigt_fc.md index f5ea67d64d..794d7931bd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/strain_from_voigt_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/strain_from_voigt_fc.md @@ -16,19 +16,19 @@ Converts the strain field from Voigt notation into standard format. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/txt_file_to_dpf.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/txt_file_to_dpf.md index a1fcbc6176..c86b32f3c1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/txt_file_to_dpf.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/txt_file_to_dpf.md @@ -10,13 +10,13 @@ license: None ## Description -Take an input string and parse it into dataProcessing type. +Take an input string and parse it into dataProcessing type ## Inputs | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_string |[`string`](./../../core-concepts/dpf-types.md#standard-types) | ex: 'double:1.0', 'int:1', 'vector:1.0;1.0' | +| Pin 0
Required| input_string |[`string`](../../core-concepts/dpf-types.md#standard-types) | ex: 'double:1.0', 'int:1', 'vector:1.0;1.0' | ## Outputs @@ -28,7 +28,7 @@ Take an input string and parse it into dataProcessing type. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/unitary_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/unitary_field.md index f1c959ee16..9a5c03004a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/unitary_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/unitary_field.md @@ -16,19 +16,19 @@ Takes a field and returns another field of scalars in the same location and scop | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](./../../core-concepts/dpf-types.md#field), [`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| field |[`field`](./../../core-concepts/dpf-types.md#field) | | +| **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/weighted_merge_fields_by_label.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/weighted_merge_fields_by_label.md index 8b92bbfec7..5e17ff0105 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/weighted_merge_fields_by_label.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/weighted_merge_fields_by_label.md @@ -16,23 +16,23 @@ Performs a weighted merge on fields of a fields container that share the same la | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| label |[`string`](./../../core-concepts/dpf-types.md#standard-types) | Label identifier that should be merged. | -| Pin 2| merged_field_support |`abstract_field_support` | The FieldsContainer's support that has already been merged. | -| Pin 3| sum_merge |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin 1000
Required| weights |`vector>>`, [`property_field`](./../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | +| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label identifier that should be merged. | +| Pin 2| merged_field_support |abstract_field_support | The FieldsContainer's support that has already been merged. | +| Pin 3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin 1000
Required| weights |vector>>, [`property_field`](../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| fields_container |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | | +| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2026R1/dpf-framework-26-r1/toc.yml b/2026R1/dpf-framework-26-r1/toc.yml index 179a5411dc..3b8cf40b12 100644 --- a/2026R1/dpf-framework-26-r1/toc.yml +++ b/2026R1/dpf-framework-26-r1/toc.yml @@ -2,32 +2,20 @@ href: index.md - name: Getting started items: - - name: Installation - href: getting-started/installation.md - - name: Licensing - href: getting-started/licensing.md - - name: Configuration - href: getting-started/configuration.md -- name: User guide - items: - - name: The server context - href: user-guide/server-context.md - - name: How to use data containers - href: user-guide/using-data-containers.md - - name: How to use operators - href: user-guide/using-operators.md - - name: Workflow examples for beginners - href: user-guide/workflow-examples.md + - name: Using data containers + href: getting-started/using-data-containers.md + - name: Using operators + href: getting-started/using-operators.md + - name: Workflow examples + href: getting-started/workflow-examples.md - name: Core concepts items: - name: Available types href: core-concepts/dpf-types.md - - name: Operator fundamentals + - name: Operator href: core-concepts/operator.md - name: Operator specifications items: - - name: Operator specifications - href: operator-specifications/operator-specifications.md - name: averaging items: - name: elemental difference @@ -188,6 +176,10 @@ href: operator-specifications/compression/apply_zfp.md - name: kmeans clustering href: operator-specifications/compression/kmeans_clustering.md + - name: quantization + href: operator-specifications/compression/quantization.md + - name: quantization fc + href: operator-specifications/compression/quantization_fc.md - name: zfp decompress href: operator-specifications/compression/zfp_decompress.md - name: filter @@ -356,6 +348,8 @@ href: operator-specifications/logic/included_fields.md - name: merge solid shell fields href: operator-specifications/logic/merge_solid_shell_fields.md + - name: solid shell fields + href: operator-specifications/logic/solid_shell_fields.md - name: split data sources href: operator-specifications/logic/split_data_sources.md - name: split streams @@ -886,8 +880,34 @@ href: operator-specifications/result/coordinate_system.md - name: co energy href: operator-specifications/result/co_energy.md + - name: creep strain + href: operator-specifications/result/creep_strain.md - name: creep strain energy density href: operator-specifications/result/creep_strain_energy_density.md + - name: creep strain eqv + href: operator-specifications/result/creep_strain_eqv.md + - name: creep strain intensity + href: operator-specifications/result/creep_strain_intensity.md + - name: creep strain max shear + href: operator-specifications/result/creep_strain_max_shear.md + - name: creep strain principal 1 + href: operator-specifications/result/creep_strain_principal_1.md + - name: creep strain principal 2 + href: operator-specifications/result/creep_strain_principal_2.md + - name: creep strain principal 3 + href: operator-specifications/result/creep_strain_principal_3.md + - name: creep strain X + href: operator-specifications/result/creep_strain_X.md + - name: creep strain XY + href: operator-specifications/result/creep_strain_XY.md + - name: creep strain XZ + href: operator-specifications/result/creep_strain_XZ.md + - name: creep strain Y + href: operator-specifications/result/creep_strain_Y.md + - name: creep strain YZ + href: operator-specifications/result/creep_strain_YZ.md + - name: creep strain Z + href: operator-specifications/result/creep_strain_Z.md - name: current density href: operator-specifications/result/current_density.md - name: cyclic analytic seqv max @@ -996,6 +1016,8 @@ href: operator-specifications/result/euler_load_buckling.md - name: euler nodes href: operator-specifications/result/euler_nodes.md + - name: fluid velocity + href: operator-specifications/result/fluid_velocity.md - name: gasket deformation href: operator-specifications/result/gasket_deformation.md - name: gasket deformation X @@ -1028,6 +1050,14 @@ href: operator-specifications/result/gasket_thermal_closure_XY.md - name: gasket thermal closure XZ href: operator-specifications/result/gasket_thermal_closure_XZ.md + - name: gasket total closure + href: operator-specifications/result/gasket_total_closure.md + - name: gasket total closure X + href: operator-specifications/result/gasket_total_closure_X.md + - name: gasket total closure XY + href: operator-specifications/result/gasket_total_closure_XY.md + - name: gasket total closure XZ + href: operator-specifications/result/gasket_total_closure_XZ.md - name: global added mass href: operator-specifications/result/global_added_mass.md - name: global added mass pct @@ -1170,14 +1200,44 @@ href: operator-specifications/result/members_in_linear_compression_bending_not_certified.md - name: migrate to h5dpf href: operator-specifications/result/migrate_to_h5dpf.md + - name: modal acceleration + href: operator-specifications/result/modal_acceleration.md - name: modal basis href: operator-specifications/result/modal_basis.md + - name: modal coordinate + href: operator-specifications/result/modal_coordinate.md + - name: modal velocity + href: operator-specifications/result/modal_velocity.md - name: nmisc href: operator-specifications/result/nmisc.md - name: nodal force href: operator-specifications/result/nodal_force.md - name: nodal moment href: operator-specifications/result/nodal_moment.md + - name: nodal rotation + href: operator-specifications/result/nodal_rotation.md + - name: nodal rotational acceleration + href: operator-specifications/result/nodal_rotational_acceleration.md + - name: nodal rotational acceleration X + href: operator-specifications/result/nodal_rotational_acceleration_X.md + - name: nodal rotational acceleration Y + href: operator-specifications/result/nodal_rotational_acceleration_Y.md + - name: nodal rotational acceleration Z + href: operator-specifications/result/nodal_rotational_acceleration_Z.md + - name: nodal rotational velocity + href: operator-specifications/result/nodal_rotational_velocity.md + - name: nodal rotational velocity X + href: operator-specifications/result/nodal_rotational_velocity_X.md + - name: nodal rotational velocity Y + href: operator-specifications/result/nodal_rotational_velocity_Y.md + - name: nodal rotational velocity Z + href: operator-specifications/result/nodal_rotational_velocity_Z.md + - name: nodal rotation X + href: operator-specifications/result/nodal_rotation_X.md + - name: nodal rotation Y + href: operator-specifications/result/nodal_rotation_Y.md + - name: nodal rotation Z + href: operator-specifications/result/nodal_rotation_Z.md - name: nodal to global href: operator-specifications/result/nodal_to_global.md - name: normal contact force @@ -1540,6 +1600,18 @@ href: operator-specifications/sound/compute_loudness_iso532_1_vs_time.md - name: compute loudness iso532 2 href: operator-specifications/sound/compute_loudness_iso532_2.md + - name: compute octave levels from psd + href: operator-specifications/sound/compute_octave_levels_from_psd.md + - name: compute octave levels from psd ansi s1 11 1986 + href: operator-specifications/sound/compute_octave_levels_from_psd_ansi_s1_11_1986.md + - name: compute octave levels from signal + href: operator-specifications/sound/compute_octave_levels_from_signal.md + - name: compute one third octave levels from psd + href: operator-specifications/sound/compute_one_third_octave_levels_from_psd.md + - name: compute one third octave levels from psd ansi s1 11 1986 + href: operator-specifications/sound/compute_one_third_octave_levels_from_psd_ansi_s1_11_1986.md + - name: compute one third octave levels from signal + href: operator-specifications/sound/compute_one_third_octave_levels_from_signal.md - name: compute overall level href: operator-specifications/sound/compute_overall_level.md - name: compute power spectral density @@ -1594,6 +1666,8 @@ href: operator-specifications/sound/filter_signal.md - name: get cropped signal href: operator-specifications/sound/get_cropped_signal.md + - name: get frequency weighting + href: operator-specifications/sound/get_frequency_weighting.md - name: isolate orders href: operator-specifications/sound/isolate_orders.md - name: load FRF from txt @@ -1662,6 +1736,8 @@ href: operator-specifications/utility/change_shell_layers.md - name: compute time scoping href: operator-specifications/utility/compute_time_scoping.md + - name: customtypefield get attribute + href: operator-specifications/utility/customtypefield_get_attribute.md - name: default value href: operator-specifications/utility/default_value.md - name: delegate to operator @@ -1682,6 +1758,10 @@ href: operator-specifications/utility/extract_time_freq.md - name: fc get attribute href: operator-specifications/utility/fc_get_attribute.md + - name: field + href: operator-specifications/utility/field.md + - name: fields container + href: operator-specifications/utility/fields_container.md - name: field clone to shell layer href: operator-specifications/utility/field_clone_to_shell_layer.md - name: field get attribute @@ -1770,14 +1850,24 @@ href: operator-specifications/utility/merge_weighted_fields.md - name: merge weighted fields containers href: operator-specifications/utility/merge_weighted_fields_containers.md + - name: mesh + href: operator-specifications/utility/mesh.md + - name: meshes container + href: operator-specifications/utility/meshes_container.md - name: mesh to mc href: operator-specifications/utility/mesh_to_mc.md + - name: operator changelog + href: operator-specifications/utility/operator_changelog.md - name: operator id href: operator-specifications/utility/operator_id.md - name: overlap fields href: operator-specifications/utility/overlap_fields.md - name: producer consumer for each href: operator-specifications/utility/producer_consumer_for_each.md + - name: propertyfield get attribute + href: operator-specifications/utility/propertyfield_get_attribute.md + - name: property field + href: operator-specifications/utility/property_field.md - name: python generator href: operator-specifications/utility/python_generator.md - name: remote operator instantiate @@ -1806,5 +1896,4 @@ href: operator-specifications/utility/unitary_field.md - name: weighted merge fields by label href: operator-specifications/utility/weighted_merge_fields_by_label.md -- name: Changelog - href: changelog/changelog-25-r2.md \ No newline at end of file + \ No newline at end of file From 7415c23fb4c7d5a136619a1acc7fd13e5dc48715 Mon Sep 17 00:00:00 2001 From: 4rmuuser <4rmuuser@win.ansys.com> Date: Wed, 1 Oct 2025 05:19:51 -0400 Subject: [PATCH 2/2] DPF doc update for 261 (2025.10.01) --- .../averaging/elemental_nodal_to_nodal_fc.md | 2 +- .../averaging/force_summation.md | 8 ++--- .../averaging/force_summation_psd.md | 8 ++--- .../composite/composite_failure_operator.md | 2 +- .../composite_field_variable_operator.md | 4 +-- .../convert_sampling_point_to_json.md | 2 +- .../composite/core_shear_operator.md | 2 +- .../composite/cuntze_operator.md | 2 +- .../evaluate_failure_criterion_per_scope.md | 6 ++-- .../composite/evaluate_sampling_point.md | 8 ++--- .../face_sheet_wrinkling_operator.md | 2 +- .../composite/hashin_operator.md | 2 +- .../composite/hill_operator.md | 2 +- .../composite/hoffman_operator.md | 2 +- .../interlaminar_normal_stress_operator.md | 2 +- .../composite/larc_operator.md | 2 +- .../composite/layup_provider_operator.md | 6 ++-- .../ls_dyna_material_support_provider.md | 2 +- .../composite/max_strain_operator.md | 2 +- .../mechanical_sampling_point_operator.md | 2 +- .../composite/minmax_per_element_operator.md | 2 +- .../multiple_failure_criteria_operator.md | 2 +- .../composite/puck_operator.md | 2 +- .../composite/reference_surface_operator.md | 2 +- .../composite/scope_config_reader.md | 2 +- .../composite/shear_crimping_operator.md | 2 +- ...short_fiber_failure_criterion_evaluator.md | 2 +- ...iber_fatigue_equivalent_stress_operator.md | 2 +- .../composite/tsai_hill_operator.md | 2 +- .../composite/tsai_wu_operator.md | 2 +- .../composite/unit_system_default.md | 4 +-- .../composite/von_mises_operator.md | 2 +- .../compression/apply_zfp.md | 2 +- .../operator-specifications/math/add.md | 2 +- .../operator-specifications/math/add_fc.md | 2 +- .../math/component_wise_divide.md | 2 +- .../math/component_wise_divide_fc.md | 2 +- .../math/component_wise_product.md | 2 +- .../math/component_wise_product_fc.md | 2 +- .../operator-specifications/math/cplx_dot.md | 2 +- .../math/cplx_multiply.md | 2 +- .../math/cross_product.md | 2 +- .../math/cross_product_fc.md | 2 +- .../operator-specifications/math/dot.md | 2 +- .../math/dot_tensor.md | 2 +- .../math/fft_approx.md | 2 +- .../math/generalized_inner_product.md | 2 +- .../math/generalized_inner_product_fc.md | 2 +- .../operator-specifications/math/minus.md | 2 +- .../operator-specifications/math/minus_fc.md | 2 +- .../math/outer_product.md | 2 +- .../math/relative_error.md | 2 +- .../math/scale_by_field.md | 2 +- .../math/scale_by_field_fc.md | 2 +- .../mesh/acmo_mesh_provider.md | 2 +- .../mesh/mesh_provider.md | 2 +- .../mesh/meshes_provider.md | 2 +- .../operator-specifications/mesh/skin.md | 2 +- .../metadata/material_support_provider.md | 2 +- .../mesh_selection_manager_provider.md | 2 +- .../metadata/mesh_support_provider.md | 2 +- .../result/acceleration.md | 2 +- .../result/acceleration_X.md | 2 +- .../result/acceleration_Y.md | 2 +- .../result/acceleration_Z.md | 2 +- .../result/beam_axial_force.md | 2 +- .../result/beam_axial_plastic_strain.md | 2 +- .../result/beam_axial_stress.md | 2 +- .../result/beam_axial_total_strain.md | 2 +- .../result/beam_rs_shear_stress.md | 2 +- .../result/beam_s_bending_moment.md | 2 +- .../result/beam_s_shear_force.md | 2 +- .../result/beam_t_bending_moment.md | 2 +- .../result/beam_t_shear_force.md | 2 +- .../result/beam_torsional_moment.md | 2 +- .../result/beam_tr_shear_stress.md | 2 +- .../contact_fluid_penetration_pressure.md | 2 +- .../result/contact_friction_stress.md | 2 +- .../result/contact_gap_distance.md | 2 +- .../result/contact_penetration.md | 2 +- .../result/contact_pressure.md | 2 +- .../result/contact_sliding_distance.md | 2 +- .../result/contact_status.md | 2 +- .../result/contact_surface_heat_flux.md | 2 +- .../result/contact_total_stress.md | 2 +- .../result/creep_strain_X.md | 2 +- .../result/creep_strain_XY.md | 2 +- .../result/creep_strain_XZ.md | 2 +- .../result/creep_strain_Y.md | 2 +- .../result/creep_strain_YZ.md | 2 +- .../result/creep_strain_Z.md | 2 +- .../result/creep_strain_intensity.md | 2 +- .../result/creep_strain_max_shear.md | 2 +- .../result/creep_strain_principal_1.md | 2 +- .../result/creep_strain_principal_2.md | 2 +- .../result/creep_strain_principal_3.md | 2 +- .../result/cyclic_expansion.md | 2 +- .../result/displacement.md | 2 +- .../result/displacement_X.md | 2 +- .../result/displacement_Y.md | 2 +- .../result/displacement_Z.md | 2 +- .../result/elastic_strain.md | 2 +- .../result/elastic_strain_X.md | 2 +- .../result/elastic_strain_XY.md | 2 +- .../result/elastic_strain_XZ.md | 2 +- .../result/elastic_strain_Y.md | 2 +- .../result/elastic_strain_YZ.md | 2 +- .../result/elastic_strain_Z.md | 2 +- .../result/elastic_strain_intensity.md | 2 +- .../result/elastic_strain_max_shear.md | 2 +- .../result/elastic_strain_principal_1.md | 2 +- .../result/elastic_strain_principal_2.md | 2 +- .../result/elastic_strain_principal_3.md | 2 +- .../elastic_strain_rotation_by_euler_nodes.md | 2 +- .../result/electric_field_X.md | 2 +- .../result/electric_field_Y.md | 2 +- .../result/electric_field_Z.md | 2 +- .../result/electric_flux_density_X.md | 2 +- .../result/electric_flux_density_Y.md | 2 +- .../result/electric_flux_density_Z.md | 2 +- .../result/element_nodal_forces.md | 2 +- .../result/element_orientations_X.md | 2 +- .../result/element_orientations_Y.md | 2 +- .../result/element_orientations_Z.md | 2 +- .../result/elemental_volume.md | 2 +- .../result/enf_rotation_by_euler_nodes.md | 2 +- .../result/equivalent_mass.md | 2 +- .../result/euler_nodes.md | 2 +- .../result/gasket_inelastic_closure_X.md | 2 +- .../result/gasket_inelastic_closure_XY.md | 2 +- .../result/gasket_inelastic_closure_XZ.md | 2 +- .../result/gasket_stress_X.md | 2 +- .../result/gasket_stress_XY.md | 2 +- .../result/gasket_stress_XZ.md | 2 +- .../result/gasket_thermal_closure_X.md | 2 +- .../result/gasket_thermal_closure_XY.md | 2 +- .../result/gasket_thermal_closure_XZ.md | 2 +- .../result/gasket_total_closure.md | 2 +- .../result/gasket_total_closure_X.md | 2 +- .../result/gasket_total_closure_XY.md | 2 +- .../result/gasket_total_closure_XZ.md | 2 +- .../result/global_added_mass.md | 2 +- .../result/global_added_mass_pct.md | 2 +- .../result/global_center_mass.md | 2 +- .../result/global_energy_ratio.md | 2 +- .../result/global_energy_ratio_wo_eroded.md | 2 +- .../result/global_eroded_hourglass_energy.md | 2 +- .../result/global_eroded_internal_energy.md | 2 +- .../result/global_eroded_kinetic_energy.md | 2 +- .../result/global_external_work.md | 2 +- .../result/global_hourglass_energy.md | 2 +- .../result/global_internal_energy.md | 2 +- .../result/global_joint_internal_energy.md | 2 +- .../result/global_kinetic_energy.md | 2 +- .../global_rigid_body_stopper_energy.md | 2 +- .../result/global_sliding_interface_energy.md | 2 +- .../result/global_spring_damper_energy.md | 2 +- .../result/global_system_damping_energy.md | 2 +- .../result/global_time_step.md | 2 +- .../result/global_total_energy.md | 2 +- .../result/global_total_mass.md | 2 +- .../result/global_velocity.md | 2 +- .../result/heat_flux.md | 2 +- .../result/heat_flux_X.md | 2 +- .../result/heat_flux_Y.md | 2 +- .../result/heat_flux_Z.md | 2 +- .../result/interface_contact_area.md | 2 +- .../result/interface_contact_force.md | 2 +- .../result/interface_contact_mass.md | 2 +- .../result/interface_contact_moment.md | 2 +- .../interface_resultant_contact_force.md | 2 +- .../result/kinetic_energy.md | 2 +- .../result/magnetic_field_X.md | 2 +- .../result/magnetic_field_Y.md | 2 +- .../result/magnetic_field_Z.md | 2 +- .../result/magnetic_flux_density_X.md | 2 +- .../result/magnetic_flux_density_Y.md | 2 +- .../result/magnetic_flux_density_Z.md | 2 +- .../operator-specifications/result/nmisc.md | 2 +- .../result/nodal_rotation_X.md | 2 +- .../result/nodal_rotation_Y.md | 2 +- .../result/nodal_rotation_Z.md | 2 +- .../result/nodal_rotational_acceleration_X.md | 2 +- .../result/nodal_rotational_acceleration_Y.md | 2 +- .../result/nodal_rotational_acceleration_Z.md | 2 +- .../result/nodal_rotational_velocity_X.md | 2 +- .../result/nodal_rotational_velocity_Y.md | 2 +- .../result/nodal_rotational_velocity_Z.md | 2 +- .../result/num_surface_status_changes.md | 2 +- .../result/part_added_mass.md | 2 +- .../result/part_eroded_internal_energy.md | 2 +- .../result/part_eroded_kinetic_energy.md | 2 +- .../result/part_hourglass_energy.md | 2 +- .../result/part_internal_energy.md | 2 +- .../result/part_kinetic_energy.md | 2 +- .../result/part_momentum.md | 2 +- .../result/part_rigid_body_velocity.md | 2 +- .../result/plastic_strain_X.md | 2 +- .../result/plastic_strain_XY.md | 2 +- .../result/plastic_strain_XZ.md | 2 +- .../result/plastic_strain_Y.md | 2 +- .../result/plastic_strain_YZ.md | 2 +- .../result/plastic_strain_Z.md | 2 +- .../result/plastic_strain_intensity.md | 2 +- .../result/plastic_strain_max_shear.md | 2 +- .../result/plastic_strain_principal_1.md | 2 +- .../result/plastic_strain_principal_2.md | 2 +- .../result/plastic_strain_principal_3.md | 2 +- .../plastic_strain_rotation_by_euler_nodes.md | 2 +- .../result/pretension.md | 4 +-- .../result/reaction_force_X.md | 2 +- .../result/reaction_force_Y.md | 2 +- .../result/reaction_force_Z.md | 2 +- .../result/rigid_transformation_provider.md | 2 +- .../operator-specifications/result/smisc.md | 2 +- .../result/stiffness_matrix_energy.md | 2 +- .../operator-specifications/result/stress.md | 2 +- .../result/stress_X.md | 2 +- .../result/stress_XY.md | 2 +- .../result/stress_XZ.md | 2 +- .../result/stress_Y.md | 2 +- .../result/stress_YZ.md | 2 +- .../result/stress_Z.md | 2 +- .../result/stress_intensity.md | 2 +- .../result/stress_max_shear.md | 2 +- .../result/stress_principal_1.md | 2 +- .../result/stress_principal_2.md | 2 +- .../result/stress_principal_3.md | 2 +- .../result/stress_rotation_by_euler_nodes.md | 2 +- .../result/stress_von_mises.md | 2 +- .../result/temperature.md | 2 +- .../result/temperature_grad_X.md | 2 +- .../result/temperature_grad_Y.md | 2 +- .../result/temperature_grad_Z.md | 2 +- .../result/thermal_strain_X.md | 2 +- .../result/thermal_strain_XY.md | 2 +- .../result/thermal_strain_XZ.md | 2 +- .../result/thermal_strain_Y.md | 2 +- .../result/thermal_strain_YZ.md | 2 +- .../result/thermal_strain_Z.md | 2 +- .../result/thermal_strain_principal_1.md | 2 +- .../result/thermal_strain_principal_2.md | 2 +- .../result/thermal_strain_principal_3.md | 2 +- .../operator-specifications/result/torque.md | 4 +-- .../result/velocity.md | 2 +- .../result/velocity_X.md | 2 +- .../result/velocity_Y.md | 2 +- .../result/velocity_Z.md | 2 +- .../result/workflow_energy_per_harmonic.md | 2 +- .../serialization/mechanical_csv_to_field.md | 2 +- .../utility/bind_support.md | 2 +- .../utility/bind_support_fc.md | 2 +- .../utility/change_shell_layers.md | 2 +- .../utility/field_clone_to_shell_layer.md | 2 +- .../utility/merge_collections.md | 2 +- .../utility/merge_data_tree.md | 2 +- .../utility/merge_fields.md | 4 +-- .../utility/merge_fields_by_label.md | 4 +-- .../utility/merge_fields_containers.md | 6 ++-- .../utility/merge_generic_data_container.md | 2 +- .../utility/merge_materials.md | 4 +-- .../utility/merge_meshes.md | 2 +- .../utility/merge_meshes_containers.md | 2 +- .../utility/merge_property_fields.md | 2 +- .../utility/merge_result_infos.md | 2 +- .../utility/merge_scopings.md | 2 +- .../utility/merge_scopings_containers.md | 2 +- .../utility/merge_string_fields.md | 2 +- .../utility/merge_supports.md | 4 +-- .../utility/merge_time_freq_supports.md | 2 +- .../utility/merge_to_field_matrix.md | 2 +- .../utility/merge_weighted_fields.md | 6 ++-- .../merge_weighted_fields_containers.md | 8 ++--- .../utility/weighted_merge_fields_by_label.md | 4 +-- 2026R1/dpf-framework-26-r1/toc.yml | 30 ++++++++++++++----- 275 files changed, 325 insertions(+), 311 deletions(-) diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md index 8fa17fcb76..4978e27234 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md @@ -30,7 +30,7 @@ Transforms Elemental Nodal fields into Nodal fields using an averaging process. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| weights |class dataProcessing::DpfTypeCollection | Gives for each node, the number of times it was found in the Elemental Nodal field. Can be used to average later. | +| **Pin 1**| weights |`class dataProcessing::DpfTypeCollection` | Gives for each node, the number of times it was found in the Elemental Nodal field. Can be used to average later. | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation.md index 27617b61cb..3b6af495fb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation.md @@ -17,12 +17,12 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | default = all time steps | -| Pin 1| nodal_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes) | -| Pin 2| elemental_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental Scoping. Set of elements contributing to the force calcuation. (default = all elements) | +| Pin 1| nodal_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Nodal Scoping or Scopings Container with a single label. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes) | +| Pin 2| elemental_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Elemental Scoping or Scopings Container with a single label. Set of elements contributing to the force calculation. (default = all elements) | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams container. Optional if using data sources. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources. Optional if using a streams container. | -| Pin 5| force_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Type of force to be processed (0 - default: Total forces (static, damping, and inertia)., 1: Static forces, 2: Damping forces, 3: Inertia forces) | -| Pin 6| spoint |[`field`](../../core-concepts/dpf-types.md#field) | Coordinate field of a point for moment summations. Defaults to (0,0,0). | +| Pin 5| force_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Type of force to be processed (0: Total forces (static, damping, and inertia)., 1 (default): Static forces, 2: Damping forces, 3: Inertia forces) | +| Pin 6| spoint |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation_psd.md b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation_psd.md index 1645d37730..2bd02fffb1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation_psd.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/averaging/force_summation_psd.md @@ -16,12 +16,12 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| nodal_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes. | -| Pin 2| elemental_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental Scoping. Set of elements contributing to the force calculation. Defaults to all elements. | +| Pin 1| nodal_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Nodal scoping or scopings container with a single label. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes. | +| Pin 2| elemental_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Elemental scoping or scopings container with a single label. Set of elements contributing to the force calculation. Defaults to all elements. | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams container for RST and PSD files (optional if using data sources). The operator supports both a single RST file and two separate RST files. See data sources pin specifications for details on how to define the streams for both cases. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources containing RST and PSD files (optional if using a streams container). The operator supports both a single RST file (containing both modal and PSD results) and two separate RST files (one for modal and one for PSD analyses).The data source containing modal results must be defined as an upstream data source.If using a single RST file for PSD and modal analysis, the RST file must be in an upstream data source.If using two separate RST files, only the modal RST must be in an upstream data source. | -| Pin 6| spoint |[`field`](../../core-concepts/dpf-types.md#field) | Coordinate field of a point for moment summations. Defaults to (0,0,0). | -| Pin 7| abs_rel_key |[`field`](../../core-concepts/dpf-types.md#field) | Key to select the type of response: 0 for relative response (default) or 1 for absolute response. | +| Pin 6| spoint |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). | +| Pin 7| abs_rel_key |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Key to select the type of response: 0 for relative response (default) or 1 for absolute response. | | Pin 8| signif |[`double`](../../core-concepts/dpf-types.md#standard-types) | Significance threshold, defaults to 0.0001. Any mode with a significance level above this value will be included in the combination.The significance level is defined as the modal covariance matrix term, divided by the maximum modal covariance matrix term. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_failure_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_failure_operator.md index 4a4cfa1dab..77846fccaf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_failure_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_failure_operator.md @@ -17,7 +17,7 @@ Uses json failure configuration to compute evaluate composite failure criterion. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 100
Required| result_definition |[`string`](../../core-concepts/dpf-types.md#standard-types) | Combined failure criterion configuration (string of json dict) | -| Pin 310| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 310| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_field_variable_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_field_variable_operator.md index e303a619d5..0138e13aac 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_field_variable_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/composite_field_variable_operator.md @@ -18,8 +18,8 @@ Enriches the materials container with the material fields (field variable) from |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 22
Required| material_fields |umap | | -| Pin 23
Required| materials_container |materials_container | | +| Pin 22
Required| material_fields |`umap` | | +| Pin 23
Required| materials_container |`materials_container` | | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/convert_sampling_point_to_json.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/convert_sampling_point_to_json.md index 4d4006f65c..6076f364de 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/convert_sampling_point_to_json.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/convert_sampling_point_to_json.md @@ -16,7 +16,7 @@ Converts a sampling point object into a sampling point json string. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| sampling_point |struct dataProcessing::composite::sampling_point::SamplingPoint | Sampling Point | +| Pin 0
Required| sampling_point |`struct dataProcessing::composite::sampling_point::SamplingPoint` | Sampling Point | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/core_shear_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/core_shear_operator.md index 10034d9d8a..123590c14d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/core_shear_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/core_shear_operator.md @@ -17,7 +17,7 @@ Computes Core Shear for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "include_ins" : true, "wf" : 1}" | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'orthotropic_homogeneous_core', 'isotropic_homogeneous_core', 'honeycomb_core' | | Pin 102
Required| mesh |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/cuntze_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/cuntze_operator.md index e0c339d710..b184d29f86 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/cuntze_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/cuntze_operator.md @@ -17,7 +17,7 @@ Computes Cuntze's failure criterion for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"b21": 0.2, "b32": 1.38, "cfc": true, "cft": true, "cma": true, "cmb": true, "cmc": true, "dim": 2, "fracture_plane_angle": 53, "mode_interaction_coeff": 2.6, "wf_cfc": 1, "wf_cft": 1, "wf_cma": 1, "wf_cmb": 1, "wf_cmc": 1}" | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_failure_criterion_per_scope.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_failure_criterion_per_scope.md index e423b5dca5..57994a8840 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_failure_criterion_per_scope.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_failure_criterion_per_scope.md @@ -19,8 +19,8 @@ Evaluates failure criteria for a specified scope. | Pin 1
Required| element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Element scoping on which failure criteria are evaluated | | Pin 3
Required| stream_provider |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Stream with result file. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh (including layup information if available) | -| Pin 22| material_fields |umap | Material fields: Only needed if has_layup_provider is true | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 22| material_fields |`umap` | Material fields: Only needed if has_layup_provider is true | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 24| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section Data Container: Only needed if has_layup_provider is true | | Pin 25| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mesh Properties Container Container: Only needed if has_layup_provider is true | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Failure criteria configuration | @@ -28,7 +28,7 @@ Evaluates failure criteria for a specified scope. | Pin 218
Required| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Define the source of section data. Values are: 0=not available, 1=ACP, 2=RST, 3=MIXED (ACP+RST). | | Pin 302
Required| request_sandwich_results |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Request results for sandwich failure criteria. | | Pin 303| use_live_evaluation |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Use live evaluation. Default: False | -| Pin 307
Required| scope_configuration |struct dataProcessing::composite::CompositeScopeConfig | Scope configuration | +| Pin 307
Required| scope_configuration |`struct dataProcessing::composite::CompositeScopeConfig` | Scope configuration | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_sampling_point.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_sampling_point.md index fdbba5a699..be874657e5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_sampling_point.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/evaluate_sampling_point.md @@ -18,15 +18,15 @@ Creates a sampling point object. |-------|-------|------------------|-------------| | Pin 1
Required| element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Element scoping | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh | -| Pin 21
Required| material_support |abstract_field_support | Material Support | -| Pin 23
Required| materials_container |materials_container | Materials Container | +| Pin 21
Required| material_support |`abstract_field_support` | Material Support | +| Pin 23
Required| materials_container |`materials_container` | Materials Container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section data container | | Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to get the sampling point for solid models. Not needed for shells. | | Pin 304
Required| failure_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container that contains the failure values | | Pin 306
Required| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | requested_time_id | | Pin 308
Required| extract_max_failure_per_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, extract maximum failure value per layer. Otherwise get max values per spot. | | Pin 309
Required| check_mechanical_unit_system |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Check mechancial unit system. If true, checks that unit system is supported by mechanical | -| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 310
Required| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | | Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Strains Container | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Stresses Container | @@ -34,7 +34,7 @@ Creates a sampling point object. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| struct dataProcessing::composite::sampling_point::SamplingPoint |struct dataProcessing::composite::sampling_point::SamplingPoint | Sampling Point | +| **Pin 0**| struct dataProcessing::composite::sampling_point::SamplingPoint |`struct dataProcessing::composite::sampling_point::SamplingPoint` | Sampling Point | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/face_sheet_wrinkling_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/face_sheet_wrinkling_operator.md index 050b4351b0..4daa740af4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/face_sheet_wrinkling_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/face_sheet_wrinkling_operator.md @@ -17,7 +17,7 @@ Computes face-sheet wrinkling criterion for layered elements. Use the composite: | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Layup Container with layer thicknesses, angles etc. | | Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to compute Wrinkling for solids. Not needed to compute wrinkling for shells. | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"homogeneous_core_coeff" : 0.5, "honeycomb_core_coeff" : 0.33, "wf" : 1.0} | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hashin_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hashin_operator.md index cfc1e48623..37e0c5d8a8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hashin_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hashin_operator.md @@ -17,7 +17,7 @@ Computes hashin criterion for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": false, "dim" : 2, "hd" : false, "hf" : true, "hm" : true, "wf_hd" : 1, "wf_hf" : 1, "wf_hm" : 1}" | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'regular'. | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hill_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hill_operator.md index 0e2c44bb02..c492f6070e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hill_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hill_operator.md @@ -17,7 +17,7 @@ Computes Hill for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification: For instance `{'active': true, 'dim': 2, 'wf': 1}` | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hoffman_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hoffman_operator.md index 818d725cb5..693bc692bb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/hoffman_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/hoffman_operator.md @@ -17,7 +17,7 @@ Computes Hoffman for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/interlaminar_normal_stress_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/interlaminar_normal_stress_operator.md index ed8fb22d18..5a952a873d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/interlaminar_normal_stress_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/interlaminar_normal_stress_operator.md @@ -17,7 +17,7 @@ Computes the interlaminar normal stresses and updates the stress container | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |materials_container | Materials Container | +| Pin 23
Required| materials_container |`materials_container` | Materials Container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section data fields container | | Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mesh property fields container | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Whether to check if all the inputs have the same meshed region. This check can become expensive | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/larc_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/larc_operator.md index 643cf48ca8..c534a00933 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/larc_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/larc_operator.md @@ -17,7 +17,7 @@ Computes Larc for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Layup Container with layer thicknesses, angles etc. | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"active": True, "dim" : 2, "lfc" : True, "lft" : True, "lmc" : True, "lmt" : True, "wf_lfc" : 1, "wf_lft" : 1, "wf_lmc" : 1, "wf_lmt" : 1} | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/layup_provider_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/layup_provider_operator.md index 2f79db40b9..ad27f7f8a5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/layup_provider_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/layup_provider_operator.md @@ -19,8 +19,8 @@ Import section data from ACP's composite definition files and/or | Pin 3
Required| rst_stream |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Stream of the RST file(s). Set this input to import section data from this source. Elements with section data from data_sources are skipped. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | DataSource of composite definitions (h5) files with mapping files to import lay-up information with additional ACP specific information. Use the sResultKey to name the parts. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 21
Required| abstract_field_support |abstract_field_support | The material support originating from an RST file. | -| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Layup quantities are converted into this unit system. Can be unit system object, result_info object int or string. In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 21
Required| abstract_field_support |`abstract_field_support` | The material support originating from an RST file. | +| Pin 310
Required| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Layup quantities are converted into this unit system. Can be unit system object, result_info object int or string. In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | | Pin 500
Required| skip_reinforcing_plies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The post-processing of reinforcing plies is not supported and so an error is thrown by default if such entities are found. Set 'skip_reinforcing_plies' to true to ignore them and to process the layered elements. Note that it is planned to support reinforcing elements and then this input will be removed again. | ## Outputs @@ -28,7 +28,7 @@ Import section data from ACP's composite definition files and/or | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| update |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Request this output to run the operator. Returns always true. Only useful in a workflow context whereexplicit runs are not possible. | -| **Pin 22**| material_fields |umap | A unordered map with key the variable material field name and value the corresponding ImportedMaterialField struct. | +| **Pin 22**| material_fields |`umap` | A unordered map with key the variable material field name and value the corresponding ImportedMaterialField struct. | | **Pin 24**| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing the angles, the thicknesses and the laminate offset of each layer. | | **Pin 25**| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing mesh properties (curvature, element edge length etc.). Only available if composite definitions are passed to the input. | | **Pin 218**| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Returns the type of lay-up model. 0=Not available, 1=ACP, 2=RST, 3=Mixed. Mixed means that section data from ACP and the RST file were imported. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_material_support_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_material_support_provider.md index 2c7bdab54e..cca580ab70 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_material_support_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/ls_dyna_material_support_provider.md @@ -22,7 +22,7 @@ Extracts the material IDs and VUUIDs from a k file and provides a material suppo | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| abstract_field_support |abstract_field_support | Material support (CFieldSupportBase). | +| **Pin 0**| abstract_field_support |`abstract_field_support` | Material support (CFieldSupportBase). | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_strain_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_strain_operator.md index 3e13f76d80..c1a898e529 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_strain_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/max_strain_operator.md @@ -17,7 +17,7 @@ Computes max strain for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |materials_container | | +| Pin 23
Required| materials_container |`materials_container` | | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification: For instance {"active": true, "e1": true, "e12": true, "e13": false, "e2": true, "e23": false, "e3": false, "eSxy": 0, "eSxz": 0, "eSyz": 0, "eXc": 0, "eXt": 0, "eYc": 0, "eYt": 0, "eZc": 0, "eZt": 0, "force_global_strain_limits": false, "wf_e1": 1, "wf_e12": 1, "wf_e13": 1, "wf_e2": 1, "wf_e23": 1, "wf_e3": 1} | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/mechanical_sampling_point_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/mechanical_sampling_point_operator.md index c10744c371..7423b82f93 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/mechanical_sampling_point_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/mechanical_sampling_point_operator.md @@ -17,7 +17,7 @@ Uses json failure configuration to compute evaluate composite sampling point. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 100
Required| result_definition |[`string`](../../core-concepts/dpf-types.md#standard-types) | Combined sampling point configuration (string of json dict | -| Pin 310| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 310| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/minmax_per_element_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/minmax_per_element_operator.md index 59e74595df..7b883f39c2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/minmax_per_element_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/minmax_per_element_operator.md @@ -18,7 +18,7 @@ Computes minmax Elemental data per element |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 21
Required| material_support |abstract_field_support | | +| Pin 21
Required| material_support |`abstract_field_support` | | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/multiple_failure_criteria_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/multiple_failure_criteria_operator.md index dc478aa80d..9ab95d104c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/multiple_failure_criteria_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/multiple_failure_criteria_operator.md @@ -17,7 +17,7 @@ Uses failure configuration, CMeshedRegion and stress and strain fields to comput | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The mesh region which is consistent with the strain and stress containers. | -| Pin 23
Required| materials_container |materials_container | | +| Pin 23
Required| materials_container |`materials_container` | | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section data fields container. Only needed for some of the failure criteria evaluations. | | Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mesh property fields container. Only needed if eLayupModelContextPin (218) is true. | | Pin 100
Required| configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Combined failure criterion configuration (string of json dict | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/puck_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/puck_operator.md index 0fedee7562..f682da560d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/puck_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/puck_operator.md @@ -17,7 +17,7 @@ Computes Puck for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"force_global_constants": false, "dim": 2, "p_21_pos": 0.325, "p_21_neg": 0.275, "p_22_neg": 0.225, "p_22_pos": 0.225, "interface_weakening_factor": 0.8, "s": 0.5, "M": 0.5, "pf": false, "pma": false, "pmb": false, "pmc": false, "pd": false, "wf_pf": 1., "wf_pma": 1., "wf_pmb": 1., "wf_pmc": 1., "wf_pd": 1., "cfps": true} | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/reference_surface_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/reference_surface_operator.md index 4733f8e842..a272694685 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/reference_surface_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/reference_surface_operator.md @@ -17,7 +17,7 @@ Reads the reference surface from solid composite definition file(s) and generate | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | List of composite definitions (h5) files with mapping files. Use the sResultKey to name the parts. | -| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Unit system. The output (mesh) will be converted into this unit system. | +| Pin 310
Required| unit_system |`class dataProcessing::unit::CUnitSystem`, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Unit system. The output (mesh) will be converted into this unit system. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_config_reader.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_config_reader.md index 1cc004cbf0..c0a6b197e1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_config_reader.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/scope_config_reader.md @@ -23,7 +23,7 @@ Reads scope configuration from inputs and outputs a CompositeScopeConfig object. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| scope_configuration |struct dataProcessing::composite::CompositeScopeConfig | Scope configuration | +| **Pin 0**| scope_configuration |`struct dataProcessing::composite::CompositeScopeConfig` | Scope configuration | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/shear_crimping_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/shear_crimping_operator.md index 741ad8719c..5b9a5ab662 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/shear_crimping_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/shear_crimping_operator.md @@ -17,7 +17,7 @@ Computes shear crimping criterion for layered elements. Use the composite::layup | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section Data Container | | Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to compute Shear Crimping for solids. Not needed to compute wrinkling for shells. | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "kc" : 1., "kf" : 0., "wf" : 1.0}" | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md index c306f25604..cde59502be 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md @@ -27,7 +27,7 @@ Evaluates failure criteria for short fiber composites. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldsContainer of CFields with the failure value results under the label is_failure_value = 1 and failure modes under the label is_failure_value = 0 from a specific failure criterion operator. | -| **Pin 1**| materials_container |materials_container | Materials container enriched with field variables and temperature. | +| **Pin 1**| materials_container |`materials_container` | Materials container enriched with field variables and temperature. | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md index 339ed2ce34..00a6f14562 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md @@ -17,7 +17,7 @@ Computes Hill-type Equivalent Stress for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_hill_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_hill_operator.md index 7da79da709..cf8b901383 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_hill_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_hill_operator.md @@ -17,7 +17,7 @@ Computes Tsai-Hill for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_wu_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_wu_operator.md index 3ffe5156fa..e2d35f25e8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_wu_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/tsai_wu_operator.md @@ -17,7 +17,7 @@ Computes Tsai-Wu for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/unit_system_default.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/unit_system_default.md index 84b5639f53..7873c26f97 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/unit_system_default.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/unit_system_default.md @@ -17,13 +17,13 @@ Returns the in the rst stream if specified, otherwise return the default unit sy | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 3
Required| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Stream with result file | -| Pin 50
Required| default_unit_system |class boost::optional | default_unit_system | +| Pin 50
Required| default_unit_system |`class boost::optional` | default_unit_system | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| unit_system |class dataProcessing::unit::CUnitSystem | unit_system | +| **Pin 0**| unit_system |`class dataProcessing::unit::CUnitSystem` | unit_system | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/composite/von_mises_operator.md b/2026R1/dpf-framework-26-r1/operator-specifications/composite/von_mises_operator.md index a04d35e9ca..c98fd5e97d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/composite/von_mises_operator.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/composite/von_mises_operator.md @@ -17,7 +17,7 @@ Computes VonMises for ElementalNodal data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 23
Required| materials_container |materials_container | Materials container | +| Pin 23
Required| materials_container |`materials_container` | Materials container | | Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "vme" : true, "vms" : true, "wf_vme" : 1.0, "wf_vms" : 1.0}" | | Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | | Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_zfp.md b/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_zfp.md index 8de0f3349a..14600f5769 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_zfp.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/compression/apply_zfp.md @@ -17,7 +17,7 @@ Compressing input data using one of zfp compression algorithm modes. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| dataIn |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container to be compressed | -| Pin 1
Required| mode |[`string`](../../core-concepts/dpf-types.md#standard-types), [`char`](../../core-concepts/dpf-types.md#char) | zfp mode: fixed-rate ('r'), fixed-precision ('p'), fixed-accuracy ('a') | +| Pin 1
Required| mode |[`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') | | Pin 2
Required| mode_parameter |[`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) | | Pin 3| dim |[`int32`](../../core-concepts/dpf-types.md#standard-types) | dimension (1D/2D/3D) for data organization before the compression (int; default: 2) | | Pin 4| order |[`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) | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/add.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/add.md index 28cf70f067..965c35edb3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/add.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/add.md @@ -29,7 +29,7 @@ Computes the sum of two fields. If one field's scoping has 'overall' location, t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/add_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/add_fc.md index f83a64c159..0065e6b04d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/add_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/add_fc.md @@ -28,7 +28,7 @@ Selects all fields with the same label space in the input fields container and a | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide.md index ffdfcafe55..b5a85aad6b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide.md @@ -29,7 +29,7 @@ Computes component-wise fraction between two fields of same dimensionality. If o | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide_fc.md index 9bf5a52e8e..a898cd5aab 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_divide_fc.md @@ -29,7 +29,7 @@ For every two fields with the same label space (from the two input fields contai | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product.md index f3dea4acc8..b7048b392d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product.md @@ -29,7 +29,7 @@ Computes component-wise product between two fields of same dimensionality. If on | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product_fc.md index 41cb8dfbc5..af0173a8ff 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/component_wise_product_fc.md @@ -29,7 +29,7 @@ Computes component-wise product between two fields of same dimensionality. If on | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_dot.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_dot.md index 5eb2dc84d8..c0b2d90a09 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_dot.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_dot.md @@ -29,7 +29,7 @@ Computes product between two field containers containing complex fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_multiply.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_multiply.md index eb5ee864fb..42844bb5f8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_multiply.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cplx_multiply.md @@ -29,7 +29,7 @@ Computes multiplication between two field containers containing complex fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product.md index 0c063e09bc..d38b84d3fd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product.md @@ -29,7 +29,7 @@ Computes the cross product of two vector fields. Fields can have the same locati | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product_fc.md index de543ef777..9a5d424414 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/cross_product_fc.md @@ -29,7 +29,7 @@ Computes the cross product of two vector fields. Fields can have the same locati | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/dot.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/dot.md index 0d9b90ceb4..1527ad1ea4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/dot.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/dot.md @@ -29,7 +29,7 @@ DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element - wise dot pr | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/dot_tensor.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/dot_tensor.md index 7ae0c05e66..fdac415016 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/dot_tensor.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/dot_tensor.md @@ -29,7 +29,7 @@ DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot prod | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_approx.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_approx.md index 3c5c6f55d5..6c93658cda 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_approx.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/fft_approx.md @@ -18,7 +18,7 @@ Computes the fitting curve using FFT filtering and cubic fitting in space (node | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0| time_scoping |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | A time scoping to rescope / split the fields container given as input. | -| Pin 1| mesh_scoping |umap, [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | A space (mesh entities) scoping (or scopings container) to rescope / split the fields container given as input. | +| Pin 1| mesh_scoping |`umap`, [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | A space (mesh entities) scoping (or scopings container) to rescope / split the fields container given as input. | | Pin 2
Required| entity_to_fit |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Data changing in time to be fitted. | | Pin 3
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Component number as an integer, for example '0' for X-displacement, '1' for Y-displacement, and so on. | | Pin 4
Required| first_derivative |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the first derivative (bool). The default is false. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product.md index 4205dd5859..36518ef372 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product.md @@ -29,7 +29,7 @@ Computes a general notion of inner product between two fields of possibly differ | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product_fc.md index c439bab966..dbd2ffb9bb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/generalized_inner_product_fc.md @@ -29,7 +29,7 @@ Computes a general notion of inner product between two fields of possibly differ | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/minus.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/minus.md index f98af0d30e..71937ee061 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/minus.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/minus.md @@ -29,7 +29,7 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/minus_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/minus_fc.md index 459c7bb234..2ec55c295c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/minus_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/minus_fc.md @@ -29,7 +29,7 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/outer_product.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/outer_product.md index efdadf5392..11f29d13fd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/outer_product.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/outer_product.md @@ -29,7 +29,7 @@ Computes the outer product of two vector fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/relative_error.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/relative_error.md index e3f4bcea9b..8951fc269a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/relative_error.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/relative_error.md @@ -31,7 +31,7 @@ Computes the relative error between a reference scalar field and another scalar | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field.md index cc95269c56..0d0ed34ffc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field.md @@ -29,7 +29,7 @@ DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field_fc.md index ec9671cae1..1ea9189eb5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/math/scale_by_field_fc.md @@ -29,7 +29,7 @@ DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |binary_operation_enum, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **binary_operation** |`binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | | **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | | **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | | **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/acmo_mesh_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/acmo_mesh_provider.md index 31cbca7bfc..28f6438ebc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/acmo_mesh_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/acmo_mesh_provider.md @@ -16,7 +16,7 @@ Converts an Assembly Mesh into a DPF Meshes container | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| assembly_mesh |ans_dispatch_holder, struct IAnsDispatch | | +| Pin 0
Required| assembly_mesh |`ans_dispatch_holder`, `struct IAnsDispatch` | | | Pin 1| unit |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_provider.md index 6a917db40d..1b0cdc7c92 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/mesh_provider.md @@ -19,7 +19,7 @@ Reads a mesh from result files. | Pin 0| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Optional time/frequency set ID of the mesh, supported for adaptative meshes. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | If 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | If 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | | Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids with one entity (vector) or region scoping with one id (scoping) (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 200| laziness |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | configurate whether lazy evaluation can be performed and to what extent. Supported attributes are:
- "num_named_selections"->num named selection to read (-1 is all, int32, default si -1), careful: the other named selections will not be available, use mesh_property_provider Operator to read them.
- all mesh property fields "mat", "named_selection", "apdl_element_type", "section"-> if set to 1 these properties will not be read and a workflow will be bounded to the properties to be evaluated on demand, with 0 they are read (default is 0).
- "all_available_properties" option set to 0 will return all possible properties | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/meshes_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/meshes_provider.md index 0fb45d7932..0cdccb206a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/meshes_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/meshes_provider.md @@ -19,7 +19,7 @@ Reads meshes from result files. Meshes can be spatially or temporally varying. | Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Time/frequency set IDs required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | | Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/skin.md b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/skin.md index a2e1ede426..a3a12ba1fc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/mesh/skin.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/mesh/skin.md @@ -27,7 +27,7 @@ Extracts a skin of the mesh in a new meshed region. The material ID of initial e |-------|------|------------------|-------------| | **Pin 0**| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Skin meshed region with facets and facets_to_ele property fields. | | **Pin 1**| nodes_mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| **Pin 2**| map_new_elements_to_old |umap | | +| **Pin 2**| map_new_elements_to_old |`umap` | | | **Pin 3**| property_field_new_elements_to_old |[`property_field`](../../core-concepts/dpf-types.md#property-field) | This property field provides, for each new face element ID (in the scoping), the corresponding 3D volume element index (in the data) it has been extracted from. The 3D volume element ID can be found with the element scoping of the input mesh. | | **Pin 4**| facet_indices |[`property_field`](../../core-concepts/dpf-types.md#property-field) | This property field gives, for each new face element ID (in the scoping), the corresponding face index on the source 3D volume element. The 3D volume element can be extracted from the previous output. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/material_support_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/material_support_provider.md index 405abb59cf..2a4389543c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/material_support_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/material_support_provider.md @@ -23,7 +23,7 @@ Reads the material support. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| abstract_field_support |abstract_field_support | | +| **Pin 0**| abstract_field_support |`abstract_field_support` | | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_selection_manager_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_selection_manager_provider.md index 4643c2acd1..318bd061b6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_selection_manager_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_selection_manager_provider.md @@ -23,7 +23,7 @@ Reads mesh properties from the results files contained in the streams or data so | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mesh_selection_manager |mesh_selection_manager | | +| **Pin 0**| mesh_selection_manager |`mesh_selection_manager` | | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_support_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_support_provider.md index 2e18f6ddae..9888be6036 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_support_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/metadata/mesh_support_provider.md @@ -23,7 +23,7 @@ Reads the mesh support. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| abstract_field_support |abstract_field_support | | +| **Pin 0**| abstract_field_support |`abstract_field_support` | | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration.md index 49cd74786f..82accd8693 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration.md @@ -23,7 +23,7 @@ Read/compute nodal accelerations by calling the readers defined by the datasourc | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_X.md index 7f05fb36e9..d77a623e02 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_X.md @@ -23,7 +23,7 @@ Read/compute nodal accelerations X component of the vector (1st component) by ca | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Y.md index a0f86c9f1f..b1c4aac37b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Y.md @@ -23,7 +23,7 @@ Read/compute nodal accelerations Y component of the vector (2nd component) by ca | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Z.md index 12aa191922..9759135a33 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/acceleration_Z.md @@ -23,7 +23,7 @@ Read/compute nodal accelerations Z component of the vector (3rd component) by ca | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_force.md index 7108e6574d..b4db77b209 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_force.md @@ -20,7 +20,7 @@ Read Beam X Axial Force by calling the readers defined by the datasources. | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_plastic_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_plastic_strain.md index 7749cdb9c5..7afe7771de 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_plastic_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_plastic_strain.md @@ -21,7 +21,7 @@ Read Beam Axial Plastic strain (LSDyna) by calling the readers defined by the da | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_stress.md index ee89578e18..ec5386d1f9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_stress.md @@ -21,7 +21,7 @@ Read Beam X Axial Stress by calling the readers defined by the datasources. | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_total_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_total_strain.md index f35229b0af..4f62f38e70 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_total_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_axial_total_strain.md @@ -21,7 +21,7 @@ Read Beam X Axial Total strain by calling the readers defined by the datasources | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_rs_shear_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_rs_shear_stress.md index 7ab3581e4f..58b871a141 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_rs_shear_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_rs_shear_stress.md @@ -21,7 +21,7 @@ Read Beam RS Shear Stress (LSDyna) by calling the readers defined by the datasou | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_bending_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_bending_moment.md index b13d670d29..afa0416b00 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_bending_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_bending_moment.md @@ -20,7 +20,7 @@ Read Beam S/Y Bending Moment by calling the readers defined by the datasources. | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_shear_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_shear_force.md index b19e507a68..3a898ab1d8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_shear_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_s_shear_force.md @@ -20,7 +20,7 @@ Read Beam S/Y Shear Force by calling the readers defined by the datasources. | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_bending_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_bending_moment.md index 00a1484cd6..b3ef756d98 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_bending_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_bending_moment.md @@ -20,7 +20,7 @@ Read Beam T/Z Bending Moment by calling the readers defined by the datasources. | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_shear_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_shear_force.md index 545d60bb18..cbf953dee8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_shear_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_t_shear_force.md @@ -20,7 +20,7 @@ Read Beam T/Z Shear Force by calling the readers defined by the datasources. | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_torsional_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_torsional_moment.md index cc5639188a..3c74dd205d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_torsional_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_torsional_moment.md @@ -20,7 +20,7 @@ Read Beam Torsional Moment by calling the readers defined by the datasources. | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_tr_shear_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_tr_shear_stress.md index 921922058f..264329f0df 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_tr_shear_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/beam_tr_shear_stress.md @@ -21,7 +21,7 @@ Read Beam TR Shear Stress (LSDyna) by calling the readers defined by the datasou | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_fluid_penetration_pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_fluid_penetration_pressure.md index 85dc5f672d..eb6c900db5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_fluid_penetration_pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_fluid_penetration_pressure.md @@ -55,7 +55,7 @@ Read/compute element actual applied fluid penetration pressure by calling the re | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_friction_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_friction_stress.md index b0e1f63664..6d2cfeaa23 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_friction_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_friction_stress.md @@ -55,7 +55,7 @@ Read/compute element contact friction stress by calling the readers defined by t | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_gap_distance.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_gap_distance.md index b9d898e3cd..f7a48dd2ee 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_gap_distance.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_gap_distance.md @@ -55,7 +55,7 @@ Read/compute element contact gap distance by calling the readers defined by the | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_penetration.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_penetration.md index 68903b3ce7..8c2632893e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_penetration.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_penetration.md @@ -55,7 +55,7 @@ Read/compute element contact penetration by calling the readers defined by the d | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_pressure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_pressure.md index 88a23bc15b..d27e8b4bf1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_pressure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_pressure.md @@ -55,7 +55,7 @@ Read/compute element contact pressure by calling the readers defined by the data | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_sliding_distance.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_sliding_distance.md index ba74a18f69..229a5f686f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_sliding_distance.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_sliding_distance.md @@ -55,7 +55,7 @@ Read/compute element contact sliding distance by calling the readers defined by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_status.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_status.md index 59f941c74b..f5cdfd2a04 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_status.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_status.md @@ -55,7 +55,7 @@ Read/compute element contact status by calling the readers defined by the dataso | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_surface_heat_flux.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_surface_heat_flux.md index ce33c9cd48..d60e8641be 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_surface_heat_flux.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_surface_heat_flux.md @@ -55,7 +55,7 @@ Read/compute element total heat flux at contact surface by calling the readers d | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_total_stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_total_stress.md index 9b434929ab..80c736aeb5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_total_stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/contact_total_stress.md @@ -55,7 +55,7 @@ Read/compute element contact total stress (pressure plus friction) by calling th | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_X.md index 19d9841d4f..ef30408ce1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_X.md @@ -24,7 +24,7 @@ Read/compute element nodal component creep strains XX normal component (00 compo | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XY.md index 698e85027d..61aa94194b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XY.md @@ -24,7 +24,7 @@ Read/compute element nodal component creep strains XY shear component (01 compon | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XZ.md index a438c61998..b6d7b8b8b5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_XZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component creep strains XZ shear component (02 compon | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Y.md index 72224ec17a..639417f56b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Y.md @@ -24,7 +24,7 @@ Read/compute element nodal component creep strains YY normal component (11 compo | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_YZ.md index 6b37657304..ba7d7071ec 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_YZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component creep strains YZ shear component (12 compon | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Z.md index 3589b0ee4d..f3f8ee35fb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_Z.md @@ -24,7 +24,7 @@ Read/compute element nodal component creep strains ZZ normal component (22 compo | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_intensity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_intensity.md index 94c957e2b7..0cf4d5e20a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_intensity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_intensity.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_max_shear.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_max_shear.md index fa7178f695..ef72cbd523 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_max_shear.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_max_shear.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_1.md index 8d780d9d89..fc805ba549 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_1.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_2.md index abdf88beee..5a373ea5a8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_2.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_3.md index 1f2f2cfcf0..6cbc788205 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/creep_strain_principal_3.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_expansion.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_expansion.md index bf3a9c3668..ecc1f5b313 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_expansion.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/cyclic_expansion.md @@ -21,7 +21,7 @@ Expand cyclic results from a fieldsContainer for given sets, sectors and scoping | Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | | Pin 3| harmonic_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is true | -| Pin 6| map_size_scoping_out |umap | map provider by scoping adapter | +| Pin 6| map_size_scoping_out |`umap` | map provider by scoping adapter | | Pin 7| normalization_factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 14| merge_stages |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 16
Required| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement.md index 1ac451a4c8..007e0111f7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement.md @@ -23,7 +23,7 @@ Read/compute nodal displacements by calling the readers defined by the datasourc | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_X.md index 16f5ba0df9..d6ce0ed731 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_X.md @@ -23,7 +23,7 @@ Read/compute nodal displacements X component of the vector (1st component) by ca | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Y.md index a5a6536dbc..9dfc880823 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Y.md @@ -23,7 +23,7 @@ Read/compute nodal displacements Y component of the vector (2nd component) by ca | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Z.md index 873c78ada3..d20cfad2aa 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/displacement_Z.md @@ -23,7 +23,7 @@ Read/compute nodal displacements Z component of the vector (3rd component) by ca | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain.md index c2d78111c4..95f21728e6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain.md @@ -55,7 +55,7 @@ Read/compute element nodal component elastic strains by calling the readers defi | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_X.md index 0036beb52d..2a50b7d54d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_X.md @@ -24,7 +24,7 @@ Read/compute element nodal component elastic strains XX normal component (00 com | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XY.md index 314f700a38..7feb40198a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XY.md @@ -24,7 +24,7 @@ Read/compute element nodal component elastic strains XY shear component (01 comp | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XZ.md index 8896228889..9d96c43d3f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_XZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component elastic strains XZ shear component (02 comp | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Y.md index b781fbfbb3..5ec03a7c2c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Y.md @@ -24,7 +24,7 @@ Read/compute element nodal component elastic strains YY normal component (11 com | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_YZ.md index e612581c82..042d2261cc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_YZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component elastic strains YZ shear component (12 comp | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Z.md index 0a78cb416d..86e23d297c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_Z.md @@ -24,7 +24,7 @@ Read/compute element nodal component elastic strains ZZ normal component (22 com | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_intensity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_intensity.md index 7a6cf5e242..8fb357f8ac 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_intensity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_intensity.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_max_shear.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_max_shear.md index 11e4530da1..7cec0b0176 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_max_shear.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_max_shear.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_1.md index ef3dd06cd6..afd8faa687 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_1.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_2.md index cc876a6d38..c7a4ba6372 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_2.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_3.md index 7954689d74..bef942a7a1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_principal_3.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md index f0c7d1eca4..1ba4354d82 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md @@ -17,7 +17,7 @@ read Euler angles on elements from the result file and rotate the fields in the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream, class dataProcessing::CRstFileWrapper | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_X.md index 338442d589..c0f7512b5f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_X.md @@ -24,7 +24,7 @@ Read/compute electric field X component of the vector (1st component) by calling | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Y.md index d674086ad3..fa043846f9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Y.md @@ -24,7 +24,7 @@ Read/compute electric field Y component of the vector (2nd component) by calling | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Z.md index 3a0466df67..7b5fd455e6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_field_Z.md @@ -24,7 +24,7 @@ Read/compute electric field Z component of the vector (3rd component) by calling | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_X.md index 0cba48dab3..b65e416598 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_X.md @@ -24,7 +24,7 @@ Read/compute Electric flux density X component of the vector (1st component) by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Y.md index 60f8608ad2..93f04037e7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Y.md @@ -24,7 +24,7 @@ Read/compute Electric flux density Y component of the vector (2nd component) by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Z.md index 02bc4e8e27..f9f1732299 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/electric_flux_density_Z.md @@ -24,7 +24,7 @@ Read/compute Electric flux density Z component of the vector (3rd component) by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_nodal_forces.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_nodal_forces.md index c3160b56f8..39b403bcef 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_nodal_forces.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_nodal_forces.md @@ -55,7 +55,7 @@ Read/compute element nodal forces by calling the readers defined by the datasour | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_X.md index 40142b8434..590b3f8e05 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_X.md @@ -24,7 +24,7 @@ Read/compute element euler angles X component of the vector (1st component) by c | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Y.md index b35860a525..c707edbbdb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Y.md @@ -24,7 +24,7 @@ Read/compute element euler angles Y component of the vector (2nd component) by c | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Z.md index c9ef324a03..b038960943 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/element_orientations_Z.md @@ -24,7 +24,7 @@ Read/compute element euler angles Z component of the vector (3rd component) by c | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_volume.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_volume.md index 8bf2a282dc..6948f03239 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_volume.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/elemental_volume.md @@ -23,7 +23,7 @@ Read/compute element volume by calling the readers defined by the datasources. | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md index 5f0149a9c7..c3c4cf1882 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md @@ -17,7 +17,7 @@ read Euler angles on elements from the result file and rotate the fields in the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream, class dataProcessing::CRstFileWrapper | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_mass.md index 7fa63c4b4d..d9ff2f480a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/equivalent_mass.md @@ -23,7 +23,7 @@ Read/compute equivalent dof mass by calling the readers defined by the datasourc | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| all_dofs |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is false. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_nodes.md index 742994552f..fe521faa2f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/euler_nodes.md @@ -16,7 +16,7 @@ Reads a field made of 3 coordinates and 3 Euler angles (6 dofs) by node from the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream` | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | | Pin 5
Required| filter_zeros |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, then the field will only contain the scoping if any rotation is not zero. (default is false). | | Pin 6
Required| coord_and_euler |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, then the field has ncomp=6 with 3 coordinates and 3 Euler angles, else there is only the Euler angles (default is true). | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_X.md index dcd6fa84e9..5c1d943cc9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_X.md @@ -24,7 +24,7 @@ Read/compute elemental gasket inelastic closure XX normal component (00 componen | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XY.md index 1095edb909..79eee2ddd8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XY.md @@ -24,7 +24,7 @@ Read/compute elemental gasket inelastic closure XY shear component (01 component | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md index 8f1912eabe..64e94ec7f4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md @@ -24,7 +24,7 @@ Read/compute elemental gasket inelastic closure XZ shear component (02 component | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_X.md index 0222439349..2def6ee78e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_X.md @@ -24,7 +24,7 @@ Read/compute elemental gasket stress XX normal component (00 component) by calli | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XY.md index e39f6443e6..0f5f02d75b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XY.md @@ -24,7 +24,7 @@ Read/compute elemental gasket stress XY shear component (01 component) by callin | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XZ.md index b0384f34ab..9eb096ff38 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_stress_XZ.md @@ -24,7 +24,7 @@ Read/compute elemental gasket stress XZ shear component (02 component) by callin | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_X.md index a4dc278a10..4c0b9b27b8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_X.md @@ -24,7 +24,7 @@ Read/compute elemental gasket thermal closure XX normal component (00 component) | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XY.md index a414883287..7ce8be088b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XY.md @@ -24,7 +24,7 @@ Read/compute elemental gasket thermal closure XY shear component (01 component) | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XZ.md index 0cc6f9b3aa..9365530df2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_thermal_closure_XZ.md @@ -24,7 +24,7 @@ Read/compute elemental gasket thermal closure XZ shear component (02 component) | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure.md index 833632d1da..99c5120115 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure.md @@ -24,7 +24,7 @@ computes the gasket total closure (sum of gasket thermal closure and gasket inel | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_X.md index 44bbd540c2..30b4c8ccd1 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_X.md @@ -24,7 +24,7 @@ Read/compute elemental gasket total closure XX normal component (00 component) b | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XY.md index f40a9949da..4282e8d001 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XY.md @@ -24,7 +24,7 @@ Read/compute elemental gasket total closure XY shear component (01 component) by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XZ.md index 00a4de1a8b..1ce1daec57 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/gasket_total_closure_XZ.md @@ -24,7 +24,7 @@ Read/compute elemental gasket total closure XZ shear component (02 component) by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass.md index 4b78a2b1dd..3594ca24aa 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass.md @@ -18,7 +18,7 @@ Read Global Added Mass (LSDyna) by calling the readers defined by the datasource |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass_pct.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass_pct.md index bdec233526..9717d64679 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass_pct.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_added_mass_pct.md @@ -18,7 +18,7 @@ Read Global Added Mass (percentage) (LSDyna) by calling the readers defined by t |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_center_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_center_mass.md index 148d72fbea..5f74757747 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_center_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_center_mass.md @@ -18,7 +18,7 @@ Read Global Center of Mass (LSDyna) by calling the readers defined by the dataso |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio.md index c40794813d..cc0f5446ee 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio.md @@ -18,7 +18,7 @@ Read Global Energy Ratio (LSDyna) by calling the readers defined by the datasour |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md index b774d08ae8..8ec82acc8c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md @@ -18,7 +18,7 @@ Read Global Energy ratio without Eroded Energy (LSDyna) by calling the readers d |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_hourglass_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_hourglass_energy.md index 48a8df3ddd..6a2a71ff3b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_hourglass_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_hourglass_energy.md @@ -18,7 +18,7 @@ Read Global Eroded Hourglass Energy (LSDyna) by calling the readers defined by t |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_internal_energy.md index 2a6b044366..4f4d980595 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_internal_energy.md @@ -18,7 +18,7 @@ Read Global Eroded Internal Energy (LSDyna) by calling the readers defined by th |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_kinetic_energy.md index 0bcfde4853..e94b895761 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_eroded_kinetic_energy.md @@ -18,7 +18,7 @@ Read Global Eroded Kinetic Energy (LSDyna) by calling the readers defined by the |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_external_work.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_external_work.md index 186ce78e1b..14d03151ff 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_external_work.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_external_work.md @@ -18,7 +18,7 @@ Read Global External Work (LSDyna) by calling the readers defined by the datasou |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_hourglass_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_hourglass_energy.md index 8d7f8ee161..9c3e5099f7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_hourglass_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_hourglass_energy.md @@ -18,7 +18,7 @@ Read Global Hourglass Energy (LSDyna) by calling the readers defined by the data |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_internal_energy.md index fefa310457..2b5b99e5bf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_internal_energy.md @@ -18,7 +18,7 @@ Read Global Internal Energy (LSDyna) by calling the readers defined by the datas |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_joint_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_joint_internal_energy.md index 1a4132dc21..abe60c8b69 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_joint_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_joint_internal_energy.md @@ -18,7 +18,7 @@ Read Global Joint Internal Energy (LSDyna) by calling the readers defined by the |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_kinetic_energy.md index 86a83933d6..03c48186d7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_kinetic_energy.md @@ -18,7 +18,7 @@ Read Global Kinetic Energy (LSDyna) by calling the readers defined by the dataso |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_rigid_body_stopper_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_rigid_body_stopper_energy.md index 53e686021a..c2d24f75b0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_rigid_body_stopper_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_rigid_body_stopper_energy.md @@ -18,7 +18,7 @@ Read Global Rigid Body Stopper Energy (LSDyna) by calling the readers defined by |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_sliding_interface_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_sliding_interface_energy.md index 4a43ed7767..cfce4ecd8b 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_sliding_interface_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_sliding_interface_energy.md @@ -18,7 +18,7 @@ Read Global Sliding Interface Energy (LSDyna) by calling the readers defined by |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_spring_damper_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_spring_damper_energy.md index 05fb7e76ad..b012881380 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_spring_damper_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_spring_damper_energy.md @@ -18,7 +18,7 @@ Read Global Spring and Damper Energy (LSDyna) by calling the readers defined by |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_system_damping_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_system_damping_energy.md index 08f654b6a8..918b7f1e6c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_system_damping_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_system_damping_energy.md @@ -18,7 +18,7 @@ Read Global System Damping Energy (LSDyna) by calling the readers defined by the |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_time_step.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_time_step.md index 502f8e4f6c..fa95f0e8ef 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_time_step.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_time_step.md @@ -18,7 +18,7 @@ Read Global Time Step (LSDyna) by calling the readers defined by the datasources |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_energy.md index 4feeda3edf..6c9c1f60d7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_energy.md @@ -18,7 +18,7 @@ Read Global Total Energy (LSDyna) by calling the readers defined by the datasour |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_mass.md index 564bb024d4..8a6144207c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_total_mass.md @@ -18,7 +18,7 @@ Read Global Total Mass (LSDyna) by calling the readers defined by the datasource |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_velocity.md index 3ff1cdfad8..67b24fd829 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/global_velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/global_velocity.md @@ -18,7 +18,7 @@ Read Global Velocity (LSDyna) by calling the readers defined by the datasources. |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux.md index 8f670d1cad..cff8e6cf9a 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux.md @@ -55,7 +55,7 @@ Read/compute heat flux by calling the readers defined by the datasources. | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_X.md index 0f7fa66e42..aaee226352 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_X.md @@ -24,7 +24,7 @@ Read/compute heat flux X component of the vector (1st component) by calling the | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Y.md index 7f3a526526..9e02708644 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Y.md @@ -24,7 +24,7 @@ Read/compute heat flux Y component of the vector (2nd component) by calling the | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Z.md index 6b8f4a7b53..0bcd6ef515 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/heat_flux_Z.md @@ -24,7 +24,7 @@ Read/compute heat flux Z component of the vector (3rd component) by calling the | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_area.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_area.md index 4b51cceacf..c9b0d16a2e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_area.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_area.md @@ -19,7 +19,7 @@ Read Interface Contact Area (LSDyna) by calling the readers defined by the datas | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_force.md index 44b6e9242b..89c6d16785 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_force.md @@ -19,7 +19,7 @@ Read Interface Contact Force (LSDyna) by calling the readers defined by the data | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_mass.md index 303c2c711c..91650e772d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_mass.md @@ -19,7 +19,7 @@ Read Interface Contact Mass (LSDyna) by calling the readers defined by the datas | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_moment.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_moment.md index 67e8f7c100..ebc7a1df08 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_moment.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_contact_moment.md @@ -19,7 +19,7 @@ Read Interface Contact Moment (LSDyna) by calling the readers defined by the dat | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_resultant_contact_force.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_resultant_contact_force.md index 2146d69a20..1a886ffe96 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_resultant_contact_force.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/interface_resultant_contact_force.md @@ -19,7 +19,7 @@ Read Interface Resultant Contact Force (LSDyna) by calling the readers defined b | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/kinetic_energy.md index 0841112fe6..bf4911b164 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/kinetic_energy.md @@ -23,7 +23,7 @@ Read/compute kinetic energy by calling the readers defined by the datasources. | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_X.md index 4db0b3d85f..731a1849f5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_X.md @@ -24,7 +24,7 @@ Read/compute Magnetic Field X component of the vector (1st component) by calling | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Y.md index 53a8f8b495..cbd50fd550 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Y.md @@ -24,7 +24,7 @@ Read/compute Magnetic Field Y component of the vector (2nd component) by calling | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Z.md index 2ef6f5f08a..415cdbb254 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_field_Z.md @@ -24,7 +24,7 @@ Read/compute Magnetic Field Z component of the vector (3rd component) by calling | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_X.md index 2357f31a4b..ac2d2222bb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_X.md @@ -24,7 +24,7 @@ Read/compute Magnetic Flux Density X component of the vector (1st component) by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Y.md index ec767781f0..26a684c5ba 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Y.md @@ -24,7 +24,7 @@ Read/compute Magnetic Flux Density Y component of the vector (2nd component) by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Z.md index 5409e5e811..5a6476faf3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/magnetic_flux_density_Z.md @@ -24,7 +24,7 @@ Read/compute Magnetic Flux Density Z component of the vector (3rd component) by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nmisc.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nmisc.md index 0453735f85..2f5f6fc1b8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nmisc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nmisc.md @@ -25,7 +25,7 @@ Read/compute elemental non summable miscellaneous data by calling the readers de | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | | Pin 11| num_components |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of components for the requested item. | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_X.md index 1582579c8c..856ea303af 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_X.md @@ -23,7 +23,7 @@ Read/compute nodal rotation X component of the vector (1st component) by calling | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Y.md index 19f1cafc24..9164763b46 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Y.md @@ -23,7 +23,7 @@ Read/compute nodal rotation Y component of the vector (2nd component) by calling | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Z.md index b0c0c9cdf4..6c2a6b1e52 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotation_Z.md @@ -23,7 +23,7 @@ Read/compute nodal rotation Z component of the vector (3rd component) by calling | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_X.md index 3ab56b8e5b..461015c68d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_X.md @@ -23,7 +23,7 @@ Read/compute nodal rotational acceleration X component of the vector (1st compon | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md index f5a42d46dc..44511ec357 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md @@ -23,7 +23,7 @@ Read/compute nodal rotational acceleration Y component of the vector (2nd compon | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md index 6e8b3a8210..a9e0aac5cf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md @@ -23,7 +23,7 @@ Read/compute nodal rotational acceleration Z component of the vector (3rd compon | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_X.md index 5691e522f7..ee319b8c54 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_X.md @@ -23,7 +23,7 @@ Read/compute nodal rotational velocity X component of the vector (1st component) | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Y.md index d92f04794a..50a8170225 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Y.md @@ -23,7 +23,7 @@ Read/compute nodal rotational velocity Y component of the vector (2nd component) | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Z.md index 2582b21a5e..88d822b135 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/nodal_rotational_velocity_Z.md @@ -23,7 +23,7 @@ Read/compute nodal rotational velocity Z component of the vector (3rd component) | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/num_surface_status_changes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/num_surface_status_changes.md index bbb41fdd46..70b7525f07 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/num_surface_status_changes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/num_surface_status_changes.md @@ -55,7 +55,7 @@ Read/compute element total number of contact status changes during substep by ca | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_added_mass.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_added_mass.md index 74c8007310..12e359c1b2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_added_mass.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_added_mass.md @@ -19,7 +19,7 @@ Read Part Added Mass (LSDyna) by calling the readers defined by the datasources. | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_internal_energy.md index 287893f3e7..8f418a8e64 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_internal_energy.md @@ -19,7 +19,7 @@ Read Part Eroded Internal Energy (LSDyna) by calling the readers defined by the | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_kinetic_energy.md index f955afabcc..fe75de9284 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_eroded_kinetic_energy.md @@ -19,7 +19,7 @@ Read Part Eroded Kinetic Energy (LSDyna) by calling the readers defined by the d | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_hourglass_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_hourglass_energy.md index 7416d05b79..679e2bd696 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_hourglass_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_hourglass_energy.md @@ -19,7 +19,7 @@ Read Part Hourglass Energy (LSDyna) by calling the readers defined by the dataso | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_internal_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_internal_energy.md index d905a24a0f..fe1c1177d2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_internal_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_internal_energy.md @@ -19,7 +19,7 @@ Read Part Internal Energy (LSDyna) by calling the readers defined by the datasou | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_kinetic_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_kinetic_energy.md index f91f480cf8..cb901959cc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_kinetic_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_kinetic_energy.md @@ -19,7 +19,7 @@ Read Part Kinetic Energy (LSDyna) by calling the readers defined by the datasour | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_momentum.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_momentum.md index e9efbd047f..2f8a12506d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_momentum.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_momentum.md @@ -19,7 +19,7 @@ Read Part Momentum (LSDyna) by calling the readers defined by the datasources. | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_rigid_body_velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_rigid_body_velocity.md index f8bf4231b0..c91252e180 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/part_rigid_body_velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/part_rigid_body_velocity.md @@ -19,7 +19,7 @@ Read Part Rigid Body Velocity (LSDyna) by calling the readers defined by the dat | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_X.md index 55df0c9be1..292b867d5c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_X.md @@ -24,7 +24,7 @@ Read/compute element nodal component plastic strains XX normal component (00 com | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XY.md index 3aa35e5f03..b23eedc2b3 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XY.md @@ -24,7 +24,7 @@ Read/compute element nodal component plastic strains XY shear component (01 comp | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XZ.md index 31ddd2b307..02c4943daa 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_XZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component plastic strains XZ shear component (02 comp | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Y.md index feef066ff4..922a4c34fc 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Y.md @@ -24,7 +24,7 @@ Read/compute element nodal component plastic strains YY normal component (11 com | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_YZ.md index f6726b3ff0..220bb978b8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_YZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component plastic strains YZ shear component (12 comp | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Z.md index 17e7280e05..4a2ec4ebb6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_Z.md @@ -24,7 +24,7 @@ Read/compute element nodal component plastic strains ZZ normal component (22 com | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_intensity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_intensity.md index 48849ec3d8..d7f5e7c941 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_intensity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_intensity.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_max_shear.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_max_shear.md index 4e05a58881..7b3b07cf95 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_max_shear.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_max_shear.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_1.md index 4cc131eb40..fb881e6c89 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_1.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_2.md index 0b59836ac4..4ae13f3821 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_2.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_3.md index a0d1dbca26..a961d53adf 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_principal_3.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md index 92111fa5bd..1dc68e7b79 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md @@ -17,7 +17,7 @@ read Euler angles on elements from the result file and rotate the fields in the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream, class dataProcessing::CRstFileWrapper | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/pretension.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/pretension.md index bd43af84aa..d45ff947e8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/pretension.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/pretension.md @@ -19,10 +19,10 @@ Reads the pretension adjustment and tension force. Rotation is not allowed for t | Pin 0| time_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream | | +| Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream` | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_X.md index 6d78ddef74..c6a0e647c9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_X.md @@ -23,7 +23,7 @@ Read/compute nodal reaction forces X component of the vector (1st component) by | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Y.md index 699213ba2b..ab1aec9ee8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Y.md @@ -23,7 +23,7 @@ Read/compute nodal reaction forces Y component of the vector (2nd component) by | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Z.md index fd90e72936..1c08e8620f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/reaction_force_Z.md @@ -23,7 +23,7 @@ Read/compute nodal reaction forces Z component of the vector (3rd component) by | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation_provider.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation_provider.md index b49761b101..368d08e5fd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation_provider.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/rigid_transformation_provider.md @@ -16,7 +16,7 @@ Extracts rigid body transformation from dsub file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 3| streams |stream | streams (result file container) (optional) | +| Pin 3| streams |`stream` | streams (result file container) (optional) | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | data source of dsub file. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/smisc.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/smisc.md index b5d7361eb9..4bdd994c8e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/smisc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/smisc.md @@ -25,7 +25,7 @@ Read/compute elemental summable miscellaneous data by calling the readers define | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | | Pin 11| num_components |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of components for the requested item. | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stiffness_matrix_energy.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stiffness_matrix_energy.md index 09941f7ee7..8b18e7b77f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stiffness_matrix_energy.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stiffness_matrix_energy.md @@ -23,7 +23,7 @@ Read/compute element energy associated with the stiffness matrix by calling the | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress.md index 4cf27198b0..2f23e7e8a7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress.md @@ -55,7 +55,7 @@ Read/compute element nodal component stresses by calling the readers defined by | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_X.md index acf4d0161e..df205a2185 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_X.md @@ -24,7 +24,7 @@ Read/compute element nodal component stresses XX normal component (00 component) | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XY.md index d054e74cbf..a9b9efaa61 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XY.md @@ -24,7 +24,7 @@ Read/compute element nodal component stresses XY shear component (01 component) | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XZ.md index f8d1d985de..caebca0859 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_XZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component stresses XZ shear component (02 component) | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Y.md index ec059e4d28..fe07606a3c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Y.md @@ -24,7 +24,7 @@ Read/compute element nodal component stresses YY normal component (11 component) | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_YZ.md index 9e3d3f7eec..088efd9354 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_YZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component stresses YZ shear component (12 component) | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Z.md index 2503de5952..fd4e1b03f8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_Z.md @@ -24,7 +24,7 @@ Read/compute element nodal component stresses ZZ normal component (22 component) | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_intensity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_intensity.md index 0f5e95842a..285158e52f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_intensity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_intensity.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_max_shear.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_max_shear.md index d1c7050387..ba7dee0db0 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_max_shear.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_max_shear.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_1.md index b7c6a8baa2..1a30d65138 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_1.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_2.md index 52a720cb35..9554064ffd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_2.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_3.md index a6e81710eb..daabb4dec7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_principal_3.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md index 873c4915f3..81e4b2cffb 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md @@ -17,7 +17,7 @@ read Euler angles on elements from the result file and rotate the fields in the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), stream, class dataProcessing::CRstFileWrapper | | +| Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_von_mises.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_von_mises.md index b1f0f3252c..6cf94e49fd 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_von_mises.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/stress_von_mises.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature.md index a688ef9163..fbdb68a4d8 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature.md @@ -23,7 +23,7 @@ Read/compute temperature field by calling the readers defined by the datasources | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_X.md index 34a2e7b6f3..4f1527a846 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_X.md @@ -24,7 +24,7 @@ Read/compute Temperature Gradient X component of the vector (1st component) by c | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Y.md index a28df13816..6dee52274f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Y.md @@ -24,7 +24,7 @@ Read/compute Temperature Gradient Y component of the vector (2nd component) by c | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Z.md index d08f7d65bf..e1e4974f81 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/temperature_grad_Z.md @@ -24,7 +24,7 @@ Read/compute Temperature Gradient Z component of the vector (3rd component) by c | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_X.md index 317d4aaf7f..dd9acab1e2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_X.md @@ -24,7 +24,7 @@ Read/compute element nodal component thermal strains XX normal component (00 com | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XY.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XY.md index 5b6888bed7..32def0ebc4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XY.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XY.md @@ -24,7 +24,7 @@ Read/compute element nodal component thermal strains XY shear component (01 comp | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XZ.md index fc994b1507..ac9bb11001 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_XZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component thermal strains XZ shear component (02 comp | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Y.md index 6fc9e2513c..8dde7f91f7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Y.md @@ -24,7 +24,7 @@ Read/compute element nodal component thermal strains YY normal component (11 com | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_YZ.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_YZ.md index 554e1db64c..5d8233a374 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_YZ.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_YZ.md @@ -24,7 +24,7 @@ Read/compute element nodal component thermal strains YZ shear component (12 comp | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Z.md index b42345f1c4..34c5646905 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_Z.md @@ -24,7 +24,7 @@ Read/compute element nodal component thermal strains ZZ normal component (22 com | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_1.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_1.md index 495c6ca7d8..c650e35d86 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_1.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_1.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_2.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_2.md index e9b44928bc..25f647e76d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_2.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_2.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_3.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_3.md index e3150021ff..79b820beee 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_3.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/thermal_strain_principal_3.md @@ -25,7 +25,7 @@ This operation is independent of the coordinate system unless averaging across e | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin is removed for versions >25.2. An error is raised if connected. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/torque.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/torque.md index 61b332bdcd..090d2a320e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/torque.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/torque.md @@ -16,8 +16,8 @@ Compute torque of a force based on a 3D point. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | -| Pin 1
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | field | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container containing the nodal forces. | +| Pin 1
Required| spoint |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field or fields container containing the summation points for each associated field on pin 0. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity.md index d319715bd5..1d2cebad29 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity.md @@ -23,7 +23,7 @@ Read/compute nodal velocities by calling the readers defined by the datasources. | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | | Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | | Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_X.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_X.md index 00959ce4ac..1e432a7ef5 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_X.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_X.md @@ -23,7 +23,7 @@ Read/compute nodal velocities X component of the vector (1st component) by calli | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Y.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Y.md index d7ca498dfb..039b70d462 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Y.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Y.md @@ -23,7 +23,7 @@ Read/compute nodal velocities Y component of the vector (2nd component) by calli | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Z.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Z.md index b388380794..321d124cad 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Z.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/velocity_Z.md @@ -23,7 +23,7 @@ Read/compute nodal velocities Z component of the vector (3rd component) by calli | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_harmonic.md b/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_harmonic.md index f979c2eb1c..098c0f1508 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_harmonic.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/result/workflow_energy_per_harmonic.md @@ -19,7 +19,7 @@ Calculates the cumulated energy per harmonic in a multistage multiharmonic model | Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Master scoping. All harmonics will be intersected with this scoping. | | Pin 2| energy_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain energy, 2: Kinetic energy) | -| Pin 3
Required| stream |stream | | +| Pin 3
Required| stream |`stream` | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/mechanical_csv_to_field.md b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/mechanical_csv_to_field.md index 05b95ee5ff..9041c5aa8f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/serialization/mechanical_csv_to_field.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/serialization/mechanical_csv_to_field.md @@ -16,7 +16,7 @@ Reads mechanical exported csv file | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| unit |class dataProcessing::unit::CUnit | | +| Pin 0
Required| unit |`class dataProcessing::unit::CUnit` | | | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | | Pin 9
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types), [`field_definition`](../../core-concepts/dpf-types.md#field-definition) | | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support.md index cf616806ce..3f908bba45 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support.md @@ -17,7 +17,7 @@ Ties a support to a field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| support |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), abstract_field_support | meshed region or a support of the field | +| Pin 1
Required| support |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), `abstract_field_support` | meshed region or a support of the field | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support_fc.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support_fc.md index 5c95480169..a9537427f6 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support_fc.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/bind_support_fc.md @@ -17,7 +17,7 @@ Ties a support to a fields container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| support |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), abstract_field_support, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | Meshed region or a support of the field. | +| Pin 1
Required| support |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), `abstract_field_support`, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | Meshed region or a support of the field. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_shell_layers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_shell_layers.md index 4084ad3734..7770f9e129 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_shell_layers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/change_shell_layers.md @@ -17,7 +17,7 @@ Extract the requested shell layers from the input fields. If the fields contain | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| e_shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types), enum dataProcessing::EShellLayers | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | +| Pin 1
Required| e_shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types), `enum dataProcessing::EShellLayers` | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | | Pin 2| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | Mesh support of the input fields_container, in case it does not have one defined. If the fields_container contains mixed shell/solid results, the mesh is required (either by connecting this pin or in the support). | | Pin 26| merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For fields with mixed shell layers (solid/shell elements with heterogeneous shell layers), group all of them in the same field (false by default). | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_clone_to_shell_layer.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_clone_to_shell_layer.md index 5b0ba086b6..e1ce5a05c2 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_clone_to_shell_layer.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/field_clone_to_shell_layer.md @@ -17,7 +17,7 @@ Generates a Field from the Field in input 0 that has the same FieldDefinition wi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types), enum dataProcessing::EShellLayers | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | +| Pin 1
Required| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types), `enum dataProcessing::EShellLayers` | 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. | | Pin 2| duplicate_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, a new scoping is computed for the output Field. If false, the input Field scoping is used. Default is false. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_collections.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_collections.md index b05a4990b7..92f1b7f95c 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_collections.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_collections.md @@ -16,7 +16,7 @@ Merges a set of collections into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| collections |vector>, [`any_collection`](../../core-concepts/dpf-types.md#any-collection) | a vector of collections to merge or collections from pin 0 to ... | +| Pin 0
Required| collections |`vector>`, [`any_collection`](../../core-concepts/dpf-types.md#any-collection) | a vector of collections to merge or collections from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_data_tree.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_data_tree.md index 3c30ecfbd9..73d3a161e7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_data_tree.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_data_tree.md @@ -16,7 +16,7 @@ Merges a list of data trees. Attributes names shouldn't be shared accross data t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| data_tree |[`data_tree`](../../core-concepts/dpf-types.md#data-tree), vector> | Either a vector of data trees or data trees from pin 0 to ... to merge. | +| Pin 0
Required| data_tree |[`data_tree`](../../core-concepts/dpf-types.md#data-tree), `vector>` | Either a vector of data trees or data trees from pin 0 to ... to merge. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields.md index 45da359af3..bee3671ae7 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields.md @@ -17,8 +17,8 @@ Assembles a set of fields into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin -2| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin -1| merged_support |abstract_field_support | Already merged field support. | -| Pin 0
Required| fields |vector>, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | +| Pin -1| merged_support |`abstract_field_support` | Already merged field support. | +| Pin 0
Required| fields |`vector>`, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_by_label.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_by_label.md index 9760cda530..65829a37ec 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_by_label.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_by_label.md @@ -18,7 +18,7 @@ Merges the fields of a fields container that share the same label value. |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label identifier that should be merged. | -| Pin 2| merged_field_support |abstract_field_support | The FieldsContainer's support that has already been merged. | +| Pin 2| merged_field_support |`abstract_field_support` | The FieldsContainer's support that has already been merged. | | Pin 3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | ## Outputs @@ -26,7 +26,7 @@ Merges the fields of a fields container that share the same label value. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| **Pin 1**| merged_field_support |abstract_field_support | | +| **Pin 1**| merged_field_support |`abstract_field_support` | | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_containers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_containers.md index c6e2bee658..32455e3113 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_containers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_fields_containers.md @@ -18,9 +18,9 @@ Assembles a set of fields containers into a unique one. |-------|-------|------------------|-------------| | Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | | Pin -3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin -2| merged_fields_support |abstract_field_support | Already merged field support. | -| Pin -1| merged_fields_containers_support |abstract_field_support, umap> | Already merged fields containers support. | -| Pin 0
Required| fields_containers |vector>, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | +| Pin -2| merged_fields_support |`abstract_field_support` | Already merged field support. | +| Pin -1| merged_fields_containers_support |`abstract_field_support`, `umap>` | Already merged fields containers support. | +| Pin 0
Required| fields_containers |`vector>`, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_generic_data_container.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_generic_data_container.md index 26e7fce5f8..7c5fac77ca 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_generic_data_container.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_generic_data_container.md @@ -16,7 +16,7 @@ Merges a list of generic data container. For each data entry, the merge operatio | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| generic_data_container |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container), vector> | Either a vector of generic data containers (sharing the same data types) or generic data containers from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. | +| Pin 0
Required| generic_data_container |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container), `vector>` | Either a vector of generic data containers (sharing the same data types) or generic data containers from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_materials.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_materials.md index b402d4ec17..4bee76ef99 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_materials.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_materials.md @@ -16,13 +16,13 @@ Assembles a set of materials into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| materials |vector>, materials | A vector of materials to merge or materials from pin 0 to ... | +| Pin 0
Required| materials |`vector>`, `materials` | A vector of materials to merge or materials from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_materials |materials | | +| **Pin 0**| merged_materials |`materials` | | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes.md index c7f0c69207..5b4264c2a9 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes.md @@ -18,7 +18,7 @@ Take a set of meshes and assemble them in a unique one |-------|-------|------------------|-------------| | Pin -201| naive_merge_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, merge the elemental Property Fields of the input meshes assuming that there is no repetition in their scoping ids. Default is false. | | Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For certain types of files (such as RST), scoping from names selection does not need to be merged.If this pin is true, the merge occurs. If this pin is false, the merge does not occur. Default is true. | -| Pin 0
Required| meshes |vector>, [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | A vector of meshed region to merge or meshed region from pin 0 to ... | +| Pin 0
Required| meshes |`vector>`, [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | A vector of meshed region to merge or meshed region from pin 0 to ... | | Pin 101| merge_method |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: merge by distance, 1: merge by node id (default) | | Pin 102| box_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | Box size used when merging by distance. Default value is 1e-12. | | Pin 103| remove_duplicate_elements |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: keep duplicate elements (default), 1: remove duplicate elements | diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes_containers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes_containers.md index 7ad089d909..1d7f52dd93 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes_containers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_meshes_containers.md @@ -16,7 +16,7 @@ Assembles a set of meshes containers into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| meshes_containers |vector>, [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | a vector of meshes containers to merge or meshes containers from pin 0 to ... | +| Pin 0
Required| meshes_containers |`vector>`, [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | a vector of meshes containers to merge or meshes containers from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_property_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_property_fields.md index 3fd678f068..8c1e1fc859 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_property_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_property_fields.md @@ -17,7 +17,7 @@ Assembles a set of property fields into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin -201
Required| naive_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, merge the input property fields assuming that there is no repetition in their scoping ids. Default is false. | -| Pin 0
Required| property_fields |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | Either a property fields container, a vector of property fields to merge or property fields from pin 0 to ... | +| Pin 0
Required| property_fields |`vector>`, [`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | Either a property fields container, a vector of property fields to merge or property fields from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_result_infos.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_result_infos.md index 51c33d82d5..72fdb7e234 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_result_infos.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_result_infos.md @@ -16,7 +16,7 @@ Assembles a set of result information into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| result_infos |vector>, [`result_info`](../../core-concepts/dpf-types.md#result-info) | A vector of result info containers to merge or result infos from pin 0 to ... | +| Pin 0
Required| result_infos |`vector>`, [`result_info`](../../core-concepts/dpf-types.md#result-info) | A vector of result info containers to merge or result infos from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings.md index 54d3c32e1e..ce9b144758 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings.md @@ -16,7 +16,7 @@ Assembles a set of scopings into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| scopings |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), vector> | Either a scopings container, a vector of scopings to merge, or scopings from pin 0 to ... | +| Pin 0
Required| scopings |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), `vector>` | Either a scopings container, a vector of scopings to merge, or scopings from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings_containers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings_containers.md index 291d7f1145..0162a10387 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings_containers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_scopings_containers.md @@ -16,7 +16,7 @@ Assembles a set of scopings containers into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| scopings_containers |vector>, [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | A vector of scopings containers to merge or scopings containers from pin 0 to ... | +| Pin 0
Required| scopings_containers |`vector>`, [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | A vector of scopings containers to merge or scopings containers from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_string_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_string_fields.md index 23d82acbba..70274db435 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_string_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_string_fields.md @@ -16,7 +16,7 @@ Assembles a set of string fields into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| string_fields |vector>, [`string_field`](../../core-concepts/dpf-types.md#string-field) | Either a a vector of string fields to merge or string fields from pin 0 to ... | +| Pin 0
Required| string_fields |`vector>`, [`string_field`](../../core-concepts/dpf-types.md#string-field) | Either a a vector of string fields to merge or string fields from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_supports.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_supports.md index 3191db4861..3d1225625e 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_supports.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_supports.md @@ -17,13 +17,13 @@ Assembles a set of supports into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | -| Pin 0
Required| supports |vector>, abstract_field_support | A vector of supports to merge or supports from pin 0 to ... | +| Pin 0
Required| supports |`vector>`, `abstract_field_support` | A vector of supports to merge or supports from pin 0 to ... | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| merged_support |abstract_field_support | | +| **Pin 0**| merged_support |`abstract_field_support` | | ## Configurations diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_time_freq_supports.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_time_freq_supports.md index d415308bdb..175362fd95 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_time_freq_supports.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_time_freq_supports.md @@ -16,7 +16,7 @@ Assembles a set of time/frequency supports into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_supports |vector>, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | A vector of time/frequency supports to merge or time/frequency supports from pin 0 to ... | +| Pin 0
Required| time_freq_supports |`vector>`, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | A vector of time/frequency supports to merge or time/frequency supports from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_to_field_matrix.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_to_field_matrix.md index 72a72cce61..b45884ea59 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_to_field_matrix.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_to_field_matrix.md @@ -16,7 +16,7 @@ Assembles a set of fields into a field matrix. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields |vector>, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | +| Pin 0
Required| fields |`vector>`, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields.md index 21fb16ddda..7c46a101a4 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields.md @@ -17,9 +17,9 @@ Assembles a set of fields into a unique one, applying a weight on the sum of the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin -2| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin -1| merged_support |abstract_field_support | Already merged field support. | -| Pin 0
Required| fields |vector>, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | -| Pin 1000
Required| weights |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`property_field`](../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | +| Pin -1| merged_support |`abstract_field_support` | Already merged field support. | +| Pin 0
Required| fields |`vector>`, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | +| Pin 1000
Required| weights |`vector>`, [`property_field`](../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields_containers.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields_containers.md index 31a738d3ad..897c551b3f 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields_containers.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/merge_weighted_fields_containers.md @@ -17,10 +17,10 @@ Assembles a set of fields containers into a unique one, applying a weight on the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin -3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin -2| merged_fields_support |abstract_field_support | Already merged field support. | -| Pin -1| merged_fields_containers_support |abstract_field_support, umap> | Already merged fields containers support. | -| Pin 0
Required| fields_containers |vector>, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | -| Pin 1000
Required| weights |vector>>, class dataProcessing::DpfTypeCollection | Weights to apply to each field from pin 1000 to ... | +| Pin -2| merged_fields_support |`abstract_field_support` | Already merged field support. | +| Pin -1| merged_fields_containers_support |`abstract_field_support`, `umap>` | Already merged fields containers support. | +| Pin 0
Required| fields_containers |`vector>`, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | +| Pin 1000
Required| weights |`vector>>`, `class dataProcessing::DpfTypeCollection` | Weights to apply to each field from pin 1000 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/operator-specifications/utility/weighted_merge_fields_by_label.md b/2026R1/dpf-framework-26-r1/operator-specifications/utility/weighted_merge_fields_by_label.md index 5e17ff0105..502cdef22d 100644 --- a/2026R1/dpf-framework-26-r1/operator-specifications/utility/weighted_merge_fields_by_label.md +++ b/2026R1/dpf-framework-26-r1/operator-specifications/utility/weighted_merge_fields_by_label.md @@ -18,9 +18,9 @@ Performs a weighted merge on fields of a fields container that share the same la |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label identifier that should be merged. | -| Pin 2| merged_field_support |abstract_field_support | The FieldsContainer's support that has already been merged. | +| Pin 2| merged_field_support |`abstract_field_support` | The FieldsContainer's support that has already been merged. | | Pin 3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | -| Pin 1000
Required| weights |vector>>, [`property_field`](../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | +| Pin 1000
Required| weights |`vector>>`, [`property_field`](../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | ## Outputs diff --git a/2026R1/dpf-framework-26-r1/toc.yml b/2026R1/dpf-framework-26-r1/toc.yml index 3b8cf40b12..97ed935350 100644 --- a/2026R1/dpf-framework-26-r1/toc.yml +++ b/2026R1/dpf-framework-26-r1/toc.yml @@ -2,20 +2,32 @@ href: index.md - name: Getting started items: - - name: Using data containers - href: getting-started/using-data-containers.md - - name: Using operators - href: getting-started/using-operators.md - - name: Workflow examples - href: getting-started/workflow-examples.md + - name: Installation + href: getting-started/installation.md + - name: Licensing + href: getting-started/licensing.md + - name: Configuration + href: getting-started/configuration.md +- name: User guide + items: + - name: The server context + href: user-guide/server-context.md + - name: How to use data containers + href: user-guide/using-data-containers.md + - name: How to use operators + href: user-guide/using-operators.md + - name: Workflow examples for beginners + href: user-guide/workflow-examples.md - name: Core concepts items: - name: Available types href: core-concepts/dpf-types.md - - name: Operator + - name: Operator fundamentals href: core-concepts/operator.md - name: Operator specifications items: + - name: Operator specifications + href: operator-specifications/operator-specifications.md - name: averaging items: - name: elemental difference @@ -1896,4 +1908,6 @@ href: operator-specifications/utility/unitary_field.md - name: weighted merge fields by label href: operator-specifications/utility/weighted_merge_fields_by_label.md - \ No newline at end of file + +- name: Changelog + href: changelog/changelog.md \ No newline at end of file