Sort operators in __init__.py during operator code generation (#2146)

* Sort operators in __init__.py during operator code generation

This limits files marked as changed during operator code generation as previously it depended on the order of files returned by ' os.listdir`.

* Bump default Ansys version in update_operators.yml

* update generated code (#2147)

Co-authored-by: PProfizi <[email protected]>

---------

Co-authored-by: PyAnsys CI Bot <[email protected]>

Author: PProfizi

.github/workflows/update_operators.yml

@@ -14,7 +14,7 @@ on:
         description: "ANSYS version"
         required: false
         type: string
-        default: "251"
+        default: "252"
       standalone_branch_suffix:
         description: "Suffix of the branch on standalone"
         required: false
@@ -49,7 +49,7 @@ jobs:
         with:
           dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}
           standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
-          ANSYS_VERSION : ${{ github.event.inputs.ANSYS_VERSION || '251' }}
+          ANSYS_VERSION : ${{ github.event.inputs.ANSYS_VERSION || '252' }}
 
       - name: "Update ansys-grpc-dpf"
         shell: bash
@@ -133,9 +133,9 @@ jobs:
             src/ansys/dpf/core/operators/*
             doc/source/_static/dpf_operators.html
           commit-message: update generated code
-          title: Update generated code for DPF ${{ github.event.inputs.ANSYS_VERSION || '251' }}${{ github.event.inputs.standalone_branch_suffix || '' }} on ${{ github.ref_name }}
+          title: Update generated code for DPF ${{ github.event.inputs.ANSYS_VERSION || '252' }}${{ github.event.inputs.standalone_branch_suffix || '' }} on ${{ github.ref_name }}
           body: An update of generated code has been triggered either manually or by an update in the dpf-standalone repository.
-          branch: maint/update_code_for_${{ github.event.inputs.ANSYS_VERSION || '251' }}${{ github.event.inputs.standalone_branch_suffix || '' }}_on_${{ github.ref_name }}
+          branch: maint/update_code_for_${{ github.event.inputs.ANSYS_VERSION || '252' }}${{ github.event.inputs.standalone_branch_suffix || '' }}_on_${{ github.ref_name }}
           labels: server-sync
           token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
           reviewers: ${{ github.ref_name == 'master' && 'ansys/dpf_integration_proxies' || '' }}

src/ansys/dpf/core/operators/build.py

@@ -269,7 +269,7 @@ def build_operators():
             # Create category init file
             category_operators = os.listdir(os.path.join(this_path, category.split(".")[0]))
             with open(os.path.join(this_path, category, "__init__.py"), "wb") as category_init:
-                for category_operator in category_operators:
+                for category_operator in sorted(category_operators):
                     operator_name = category_operator.split(".")[0]
                     category_init.write(
                         f"from .{operator_name} import {operator_name}\n".encode()

src/ansys/dpf/core/operators/geo/__init__.py

@@ -1,9 +1,9 @@
 from .cartesian_to_spherical import cartesian_to_spherical
 from .cartesian_to_spherical_fc import cartesian_to_spherical_fc
+from .element_nodal_contribution import element_nodal_contribution
 from .elements_facets_surfaces_over_time import elements_facets_surfaces_over_time
 from .elements_volume import elements_volume
 from .elements_volumes_over_time import elements_volumes_over_time
-from .element_nodal_contribution import element_nodal_contribution
 from .faces_area import faces_area
 from .gauss_to_node import gauss_to_node
 from .integrate_over_elements import integrate_over_elements

src/ansys/dpf/core/operators/mapping/__init__.py

@@ -2,8 +2,8 @@
 from .find_reduced_coordinates import find_reduced_coordinates
 from .on_coordinates import on_coordinates
 from .on_reduced_coordinates import on_reduced_coordinates
-from .prepare_mapping_workflow import prepare_mapping_workflow
 from .prep_sampling_fft import prep_sampling_fft
+from .prepare_mapping_workflow import prepare_mapping_workflow
 from .scoping_on_coordinates import scoping_on_coordinates
 from .solid_to_skin import solid_to_skin
 from .solid_to_skin_fc import solid_to_skin_fc

src/ansys/dpf/core/operators/math/__init__.py

@@ -52,9 +52,9 @@
 from .mac import mac
 from .make_one_on_comp import make_one_on_comp
 from .matrix_inverse import matrix_inverse
+from .min_max_over_time import min_max_over_time
 from .minus import minus
 from .minus_fc import minus_fc
-from .min_max_over_time import min_max_over_time
 from .modal_damping_ratio import modal_damping_ratio
 from .modal_superposition import modal_superposition
 from .modulus import modulus
@@ -77,9 +77,9 @@
 from .sin import sin
 from .sin_fc import sin_fc
 from .sqr import sqr
+from .sqr_fc import sqr_fc
 from .sqrt import sqrt
 from .sqrt_fc import sqrt_fc
-from .sqr_fc import sqr_fc
 from .svd import svd
 from .sweeping_phase import sweeping_phase
 from .sweeping_phase_fc import sweeping_phase_fc

src/ansys/dpf/core/operators/mesh/__init__.py

@@ -11,7 +11,6 @@
 from .iso_surfaces import iso_surfaces
 from .make_plane_levelset import make_plane_levelset
 from .make_sphere_levelset import make_sphere_levelset
-from .meshes_provider import meshes_provider
 from .mesh_clip import mesh_clip
 from .mesh_cut import mesh_cut
 from .mesh_extraction import mesh_extraction
@@ -22,6 +21,7 @@
 from .mesh_to_graphics_edges import mesh_to_graphics_edges
 from .mesh_to_pyvista import mesh_to_pyvista
 from .mesh_to_tetra import mesh_to_tetra
+from .meshes_provider import meshes_provider
 from .node_coordinates import node_coordinates
 from .points_from_coordinates import points_from_coordinates
 from .skin import skin

src/ansys/dpf/core/operators/result/__init__.py

@@ -14,27 +14,28 @@
 from .beam_rs_shear_stress import beam_rs_shear_stress
 from .beam_s_bending_moment import beam_s_bending_moment
 from .beam_s_shear_force import beam_s_shear_force
-from .beam_torsional_moment import beam_torsional_moment
-from .beam_tr_shear_stress import beam_tr_shear_stress
 from .beam_t_bending_moment import beam_t_bending_moment
 from .beam_t_shear_force import beam_t_shear_force
+from .beam_torsional_moment import beam_torsional_moment
+from .beam_tr_shear_stress import beam_tr_shear_stress
 from .cgns_result_provider import cgns_result_provider
 from .cms_dst_table_provider import cms_dst_table_provider
 from .cms_matrices_provider import cms_matrices_provider
 from .cms_subfile_info_provider import cms_subfile_info_provider
+from .co_energy import co_energy
 from .compute_invariant_terms_motion import compute_invariant_terms_motion
 from .compute_invariant_terms_rbd import compute_invariant_terms_rbd
 from .compute_stress import compute_stress
 from .compute_stress_1 import compute_stress_1
 from .compute_stress_2 import compute_stress_2
 from .compute_stress_3 import compute_stress_3
-from .compute_stress_von_mises import compute_stress_von_mises
 from .compute_stress_X import compute_stress_X
 from .compute_stress_XY import compute_stress_XY
 from .compute_stress_XZ import compute_stress_XZ
 from .compute_stress_Y import compute_stress_Y
 from .compute_stress_YZ import compute_stress_YZ
 from .compute_stress_Z import compute_stress_Z
+from .compute_stress_von_mises import compute_stress_von_mises
 from .compute_total_strain import compute_total_strain
 from .compute_total_strain_1 import compute_total_strain_1
 from .compute_total_strain_2 import compute_total_strain_2
@@ -54,9 +55,8 @@
 from .contact_status import contact_status
 from .contact_surface_heat_flux import contact_surface_heat_flux
 from .contact_total_stress import contact_total_stress
-from .coordinates import coordinates
 from .coordinate_system import coordinate_system
-from .co_energy import co_energy
+from .coordinates import coordinates
 from .creep_strain_energy_density import creep_strain_energy_density
 from .current_density import current_density
 from .custom import custom
@@ -96,6 +96,12 @@
 from .div_lighthill_tensor import div_lighthill_tensor
 from .dynamic_viscosity import dynamic_viscosity
 from .elastic_strain import elastic_strain
+from .elastic_strain_X import elastic_strain_X
+from .elastic_strain_XY import elastic_strain_XY
+from .elastic_strain_XZ import elastic_strain_XZ
+from .elastic_strain_Y import elastic_strain_Y
+from .elastic_strain_YZ import elastic_strain_YZ
+from .elastic_strain_Z import elastic_strain_Z
 from .elastic_strain_energy_density import elastic_strain_energy_density
 from .elastic_strain_eqv import elastic_strain_eqv
 from .elastic_strain_intensity import elastic_strain_intensity
@@ -104,12 +110,6 @@
 from .elastic_strain_principal_2 import elastic_strain_principal_2
 from .elastic_strain_principal_3 import elastic_strain_principal_3
 from .elastic_strain_rotation_by_euler_nodes import elastic_strain_rotation_by_euler_nodes
-from .elastic_strain_X import elastic_strain_X
-from .elastic_strain_XY import elastic_strain_XY
-from .elastic_strain_XZ import elastic_strain_XZ
-from .elastic_strain_Y import elastic_strain_Y
-from .elastic_strain_YZ import elastic_strain_YZ
-from .elastic_strain_Z import elastic_strain_Z
 from .electric_field import electric_field
 from .electric_field_X import electric_field_X
 from .electric_field_Y import electric_field_Y
@@ -119,15 +119,15 @@
 from .electric_flux_density_Y import electric_flux_density_Y
 from .electric_flux_density_Z import electric_flux_density_Z
 from .electric_potential import electric_potential
-from .elemental_heat_generation import elemental_heat_generation
-from .elemental_mass import elemental_mass
-from .elemental_volume import elemental_volume
 from .element_centroids import element_centroids
 from .element_nodal_forces import element_nodal_forces
 from .element_orientations import element_orientations
 from .element_orientations_X import element_orientations_X
 from .element_orientations_Y import element_orientations_Y
 from .element_orientations_Z import element_orientations_Z
+from .elemental_heat_generation import elemental_heat_generation
+from .elemental_mass import elemental_mass
+from .elemental_volume import elemental_volume
 from .enf_rotation_by_euler_nodes import enf_rotation_by_euler_nodes
 from .enthalpy import enthalpy
 from .entropy import entropy
@@ -172,9 +172,9 @@
 from .global_spring_damper_energy import global_spring_damper_energy
 from .global_system_damping_energy import global_system_damping_energy
 from .global_time_step import global_time_step
+from .global_to_nodal import global_to_nodal
 from .global_total_energy import global_total_energy
 from .global_total_mass import global_total_mass
-from .global_to_nodal import global_to_nodal
 from .global_velocity import global_velocity
 from .heat_flux import heat_flux
 from .heat_flux_X import heat_flux_X
@@ -241,6 +241,12 @@
 from .part_rigid_body_velocity import part_rigid_body_velocity
 from .plastic_state_variable import plastic_state_variable
 from .plastic_strain import plastic_strain
+from .plastic_strain_X import plastic_strain_X
+from .plastic_strain_XY import plastic_strain_XY
+from .plastic_strain_XZ import plastic_strain_XZ
+from .plastic_strain_Y import plastic_strain_Y
+from .plastic_strain_YZ import plastic_strain_YZ
+from .plastic_strain_Z import plastic_strain_Z
 from .plastic_strain_energy_density import plastic_strain_energy_density
 from .plastic_strain_eqv import plastic_strain_eqv
 from .plastic_strain_intensity import plastic_strain_intensity
@@ -249,16 +255,10 @@
 from .plastic_strain_principal_2 import plastic_strain_principal_2
 from .plastic_strain_principal_3 import plastic_strain_principal_3
 from .plastic_strain_rotation_by_euler_nodes import plastic_strain_rotation_by_euler_nodes
-from .plastic_strain_X import plastic_strain_X
-from .plastic_strain_XY import plastic_strain_XY
-from .plastic_strain_XZ import plastic_strain_XZ
-from .plastic_strain_Y import plastic_strain_Y
-from .plastic_strain_YZ import plastic_strain_YZ
-from .plastic_strain_Z import plastic_strain_Z
 from .poynting_vector import poynting_vector
 from .poynting_vector_surface import poynting_vector_surface
-from .pressure import pressure
 from .pres_to_field import pres_to_field
+from .pressure import pressure
 from .pretension import pretension
 from .prns_to_field import prns_to_field
 from .raw_displacement import raw_displacement
@@ -287,6 +287,12 @@
 from .strain_eqv_as_mechanical import strain_eqv_as_mechanical
 from .strain_eqv_as_mechanical_workflow import strain_eqv_as_mechanical_workflow
 from .stress import stress
+from .stress_X import stress_X
+from .stress_XY import stress_XY
+from .stress_XZ import stress_XZ
+from .stress_Y import stress_Y
+from .stress_YZ import stress_YZ
+from .stress_Z import stress_Z
 from .stress_eqv_as_mechanical import stress_eqv_as_mechanical
 from .stress_eqv_as_mechanical_workflow import stress_eqv_as_mechanical_workflow
 from .stress_intensity import stress_intensity
@@ -297,12 +303,6 @@
 from .stress_ratio import stress_ratio
 from .stress_rotation_by_euler_nodes import stress_rotation_by_euler_nodes
 from .stress_von_mises import stress_von_mises
-from .stress_X import stress_X
-from .stress_XY import stress_XY
-from .stress_XZ import stress_XZ
-from .stress_Y import stress_Y
-from .stress_YZ import stress_YZ
-from .stress_Z import stress_Z
 from .structural_temperature import structural_temperature
 from .superficial_velocity import superficial_velocity
 from .surface_heat_rate import surface_heat_rate
@@ -317,16 +317,16 @@
 from .thermal_conductivity import thermal_conductivity
 from .thermal_dissipation_energy import thermal_dissipation_energy
 from .thermal_strain import thermal_strain
-from .thermal_strains_eqv import thermal_strains_eqv
-from .thermal_strain_principal_1 import thermal_strain_principal_1
-from .thermal_strain_principal_2 import thermal_strain_principal_2
-from .thermal_strain_principal_3 import thermal_strain_principal_3
 from .thermal_strain_X import thermal_strain_X
 from .thermal_strain_XY import thermal_strain_XY
 from .thermal_strain_XZ import thermal_strain_XZ
 from .thermal_strain_Y import thermal_strain_Y
 from .thermal_strain_YZ import thermal_strain_YZ
 from .thermal_strain_Z import thermal_strain_Z
+from .thermal_strain_principal_1 import thermal_strain_principal_1
+from .thermal_strain_principal_2 import thermal_strain_principal_2
+from .thermal_strain_principal_3 import thermal_strain_principal_3
+from .thermal_strains_eqv import thermal_strains_eqv
 from .thickness import thickness
 from .torque import torque
 from .total_contact_force import total_contact_force

src/ansys/dpf/core/operators/serialization/__init__.py

@@ -10,9 +10,9 @@
 from .json_to_data_tree import json_to_data_tree
 from .migrate_file_to_vtk import migrate_file_to_vtk
 from .migrate_to_vtu import migrate_to_vtu
+from .serialize_to_hdf5 import serialize_to_hdf5
 from .serializer import serializer
 from .serializer_to_string import serializer_to_string
-from .serialize_to_hdf5 import serialize_to_hdf5
 from .string_deserializer import string_deserializer
 from .txt_to_data_tree import txt_to_data_tree
 from .vtk_export import vtk_export

src/ansys/dpf/core/operators/utility/__init__.py

@@ -18,15 +18,15 @@
 from .extract_time_freq import extract_time_freq
 from .fc_get_attribute import fc_get_attribute
 from .field import field
-from .fields_container import fields_container
-from .fields_container_matrices_label import fields_container_matrices_label
 from .field_get_attribute import field_get_attribute
 from .field_to_fc import field_to_fc
+from .fields_container import fields_container
+from .fields_container_matrices_label import fields_container_matrices_label
+from .for_each import for_each
 from .forward import forward
 from .forward_field import forward_field
 from .forward_fields_container import forward_fields_container
 from .forward_meshes_container import forward_meshes_container
-from .for_each import for_each
 from .hdf5dpf_workglow_provider import hdf5dpf_workglow_provider
 from .html_doc import html_doc
 from .incremental_concatenate_as_fc import incremental_concatenate_as_fc
@@ -56,8 +56,8 @@
 from .merge_weighted_fields import merge_weighted_fields
 from .merge_weighted_fields_containers import merge_weighted_fields_containers
 from .mesh import mesh
-from .meshes_container import meshes_container
 from .mesh_to_mc import mesh_to_mc
+from .meshes_container import meshes_container
 from .operator_id import operator_id
 from .overlap_fields import overlap_fields
 from .producer_consumer_for_each import producer_consumer_for_each