Merge branch 'master' of https://github.com/ansys/pydpf-core

Author: rafacanton

doc/source/_static/dpf_operators.html

@@ -6604,7 +6604,7 @@ <h2 class="h2-main">Configurating operators</h2>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="9" ellipsis = "false"></pin-number-optional></td><td><pin-name name="requested_location"></pin-name></td><td><req-type typeName="(string)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="14" ellipsis = "false"></pin-number-optional></td><td><pin-name name="read_cyclic"></pin-name></td><td><req-type typeName="(enum dataProcessing::ECyclicReading | int32)"></req-type></td><td><div class = "pin-des-text"><p>if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1)</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="22" ellipsis = "false"></pin-number-optional></td><td><pin-name name="read_beams"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>elemental nodal beam results are read if this pin is set to true (default is false)</p>
 </div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="fields_container"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><config-spec name="num_threads" default="0" doc="Number of threads to use to run in parallel" types="int32" ></config-spec><config-spec name="run_in_parallel" default="true" doc="Loops are allowed to run in parallel if the value of this config is set to true." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="elastic_strain_principal_2" license="none" cat="result" plugin="core" cpp-name="EPEL2"></scripting-part></div><div class="operator" id="scoping normals" scripting_name="normals"plugin="core"cat="geo"><h1 class="op-des-h1">geo: scoping normals</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>compute the normals at the given nodes or element scoping based on the given mesh (first version, the element normal is only handled on the shell elements)</p>
-</div></figure><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number-optional n="0" ellipsis = "false"></pin-number-optional></td><td><pin-name name="mesh"></pin-name></td><td><req-type typeName="(abstract_meshed_region)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="1" ellipsis = "false"></pin-number-optional></td><td><pin-name name="mesh_scoping"></pin-name></td><td><req-type typeName="(scoping)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="3" ellipsis = "false"></pin-number-optional></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="normals" license="any_dpf_supported_increments" cat="geo" plugin="core" cpp-name="normals_provider"></scripting-part></div><div class="operator" id="merge scopings" scripting_name="merge_scopings"plugin="core"cat="utility"><h1 class="op-des-h1">utility: merge scopings</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Assembles a set of scopings into a unique one.</p>
+</div></figure><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number-optional n="0" ellipsis = "false"></pin-number-optional></td><td><pin-name name="mesh"></pin-name></td><td><req-type typeName="(abstract_meshed_region)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="1" ellipsis = "false"></pin-number-optional></td><td><pin-name name="mesh_scoping"></pin-name></td><td><req-type typeName="(scoping)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="3" ellipsis = "false"></pin-number-optional></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="normals" license="none" cat="geo" plugin="core" cpp-name="normals_provider"></scripting-part></div><div class="operator" id="merge scopings" scripting_name="merge_scopings"plugin="core"cat="utility"><h1 class="op-des-h1">utility: merge scopings</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Assembles a set of scopings into a unique one.</p>
 </div></figure><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "true"></pin-number></td><td><pin-name name="scopings"></pin-name></td><td><req-type typeName="(scoping | scopings_container | vector<shared_ptr<scoping>>)"></req-type></td><td><div class = "pin-des-text"><p>Either a scopings container, a vector of scopings to merge, or scopings from pin 0 to ...</p>
 </div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="merged_scoping"></pin-name></td><td><req-type typeName="(scoping)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="merge_scopings" license="none" cat="utility" plugin="core" cpp-name="merge::scoping"></scripting-part></div><div class="operator" id="elastic strain principal 3" scripting_name="elastic_strain_principal_3"plugin="core"cat="result"><h1 class="op-des-h1">result: elastic strain principal 3</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>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.</p>
 </div></figure><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number-optional n="0" ellipsis = "false"></pin-number-optional></td><td><pin-name name="time_scoping"></pin-name></td><td><req-type typeName="(scoping | int32 | vector<int32> | double | field | vector<double>)"></req-type></td><td><div class = "pin-des-text"><p>time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on &quot;TimeFreq_steps&quot;. Linear time freq intrapolation is performed if the values are not in the result 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.</p>
@@ -8950,7 +8950,7 @@ <h2 class="h2-main">Configurating operators</h2>
 </div></figure><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="mesh"></pin-name></td><td><req-type typeName="(abstract_meshed_region)"></req-type></td><td><div class = "pin-des-text"><p>Skin, face, or shell mesh region.</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="1" ellipsis = "false"></pin-number-optional></td><td><pin-name name="mesh_scoping"></pin-name></td><td><req-type typeName="(scoping)"></req-type></td><td><div class = "pin-des-text"><p>Elemental, ElementalNodal, or Nodal scoping. Location derived from this.</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="9" ellipsis = "false"></pin-number-optional></td><td><pin-name name="requested_location"></pin-name></td><td><req-type typeName="(string)"></req-type></td><td><div class = "pin-des-text"><p>If no scoping, specifies location. If scoping is Elemental or ElementalNodal this overrides scoping. Default is Elemental.</p>
-</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="normals_provider_nl" license="any_dpf_supported_increments" cat="geo" plugin="core" cpp-name="normals_provider_nl"></scripting-part></div><div class="operator" id="elements volumes over time" scripting_name="elements_volumes_over_time"plugin="core"cat="geo"><h1 class="op-des-h1">geo: elements volumes over time</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Calculates for a mesh, the volume of each element over time for each specified time step.</p>
+</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="normals_provider_nl" license="none" cat="geo" plugin="core" cpp-name="normals_provider_nl"></scripting-part></div><div class="operator" id="elements volumes over time" scripting_name="elements_volumes_over_time"plugin="core"cat="geo"><h1 class="op-des-h1">geo: elements volumes over time</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Calculates for a mesh, the volume of each element over time for each specified time step.</p>
 </div></figure><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number-optional n="1" ellipsis = "false"></pin-number-optional></td><td><pin-name name="scoping"></pin-name></td><td><req-type typeName="(scoping)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="2" ellipsis = "false"></pin-number-optional></td><td><pin-name name="displacement"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td><td><div class = "pin-des-text"><p>Displacement field's container. Must contain the mesh if mesh not specified in input.</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="7" ellipsis = "false"></pin-number-optional></td><td><pin-name name="mesh"></pin-name></td><td><req-type typeName="(abstract_meshed_region)"></req-type></td><td><div class = "pin-des-text"><p>Mesh must be defined if the displacement field's container does not contain it, or if there is no displacement.</p>
 </div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="fields_container"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="elements_volumes_over_time" license="any_dpf_supported_increments" cat="geo" plugin="core" cpp-name="volumes_provider"></scripting-part></div><div class="operator" id="window bartlett" scripting_name="window_bartlett"plugin="core"cat="math"><h1 class="op-des-h1">math: window bartlett</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Apply bartlett windowing on a given FieldsContainer having time label or a Field located on time. Assume that time sampling is evenly spaced (use time_freq_interpolation before otherwise).</p>

examples/02-modal_analyses/01-plot_and_animate_modes.py

@@ -72,4 +72,6 @@
 # To suppress window pop-up, set the `off_screen` argument to True.
 # ~~~~~~~~~~~~~~~~~~~~
 
-animation.animate_mode(disp, mode_number=1, save_as="tmp.gif", off_screen=True)
+animation.animate_mode(
+    disp, mode_number=1, save_as="tmp.gif", off_screen=True, deform_scale_factor=10.0
+)

src/ansys/dpf/core/animation.py

@@ -95,7 +95,14 @@ def animate_mode(
         )
 
     # Get fields
+    available_mode_numbers = fields_container.get_available_ids_for_label("time")
+
+    if not mode_number in available_mode_numbers:
+        raise ValueError(f"The mode {mode_number} data is not available in field container.")
     fields_mode = fields_container.get_fields({"time": mode_number})
+    mode_frequencies_field = fields_container.time_freq_support.time_frequencies
+    mode_frequencies = mode_frequencies_field.data
+    mode_frequency = mode_frequencies[available_mode_numbers.index(mode_number)]
 
     # Merge fields if needed
     if len(fields_mode) > 1:
@@ -108,6 +115,7 @@ def animate_mode(
 
     max_data = float(np.max(field_mode.data))
     loop_over = dpf.fields_factory.field_from_array(scale_factor_per_frame)
+    loop_over.unit = mode_frequencies_field.unit
 
     # Create workflow
     wf = dpf.Workflow()
@@ -120,6 +128,7 @@ def animate_mode(
 
     wf.set_input_name("weights", scaling_op.inputs.weights)
     wf.set_output_name("field", scaling_op.outputs.field)
+    wf.set_output_name("deform_by", scaling_op.outputs.field)
 
     anim = Animator(workflow=wf, **kwargs)
 
@@ -129,6 +138,8 @@ def animate_mode(
         output_name="field",
         save_as=save_as,
         mode_number=mode_number,
+        mode_frequency=mode_frequency,
         clim=[0, max_data],
+        scale_factor=deform_scale_factor,
         **kwargs,
     )

src/ansys/dpf/core/animator.py

@@ -59,6 +59,7 @@ def animate_workflow(
         input_name="loop_over",
         save_as="",
         mode_number=None,
+        mode_frequency=None,
         scale_factor=1.0,
         shell_layer=core.shell_layers.top,
         **kwargs,
@@ -70,7 +71,7 @@ def animate_workflow(
             scale_factor = [False] * len(indices)
         type_scale = type(scale_factor)
         if type_scale in [int, float]:
-            scale_factor = [scale_factor] * len(indices)
+            scale_factor = [float(scale_factor)] * len(indices)
         elif type_scale == list:
             pass
         # elif type_scale in [core.field.Field, core.fields_container.FieldsContainer]:
@@ -121,6 +122,7 @@ def render_frame(frame):
             self.add_field(
                 field,
                 deform_by=deform,
+                scale_factor=scale_factor[frame],
                 scale_factor_legend=scale_factor[frame],
                 shell_layer=shell_layer,
                 **kwargs,
@@ -132,9 +134,9 @@ def render_frame(frame):
                     str_template.format(indices[frame], unit, freq_fmt), **kwargs_in
                 )
             else:
-                str_template = "frq={0:{2}} {1}"
+                str_template = "mode={3}\nfrq={0:{2}} {1}"
                 self._plotter.add_text(
-                    str_template.format(mode_number, unit, freq_fmt), **kwargs_in
+                    str_template.format(mode_frequency, unit, freq_fmt, mode_number), **kwargs_in
                 )
 
             if cpos:

src/ansys/dpf/core/data_sources.py

@@ -25,7 +25,7 @@
 from __future__ import annotations
 
 import os
-from pathlib import Path
+from pathlib import Path, PurePosixPath, PureWindowsPath
 import traceback
 from typing import TYPE_CHECKING, Union
 import warnings
@@ -159,7 +159,9 @@ def set_result_file_path(
         ['...tmp...file.rst']
 
         """
-        filepath = Path(filepath)
+        filepath = (
+            PurePosixPath(filepath) if self._server.os == "posix" else PureWindowsPath(filepath)
+        )
         extension = filepath.suffix
         # Handle .res files from CFX
         if key == "" and extension == ".res":
@@ -290,7 +292,7 @@ def set_domain_result_file_path(
         >>> my_data_sources.set_domain_result_file_path(path='/tmp/file1.rst', key='rst', domain_id=1)
 
         """
-        path = Path(path)
+        path = PurePosixPath(path) if self._server.os == "posix" else PureWindowsPath(path)
         if key:
             self._api.data_sources_set_domain_result_file_path_with_key_utf8(
                 self, str(path), key, domain_id
@@ -341,7 +343,9 @@ def add_file_path(
         # The filename needs to be a fully qualified file name
         # if not os.path.dirname(filepath)
 
-        filepath = Path(filepath)
+        filepath = (
+            PurePosixPath(filepath) if self._server.os == "posix" else PureWindowsPath(filepath)
+        )
         if not filepath.parent.name:
             # append local path
             filepath = Path.cwd() / filepath.name
@@ -391,7 +395,9 @@ def add_domain_file_path(
 
         """
         # The filename needs to be a fully qualified file name
-        filepath = Path(filepath)
+        filepath = (
+            PurePosixPath(filepath) if self._server.os == "posix" else PureWindowsPath(filepath)
+        )
         if not filepath.parent.name:
             # append local path
             filepath = Path.cwd() / filepath.name
@@ -424,7 +430,9 @@ def add_file_path_for_specified_result(
             The default is ``""``, in which case the key is found directly.
         """
         # The filename needs to be a fully qualified file name
-        filepath = Path(filepath)
+        filepath = (
+            PurePosixPath(filepath) if self._server.os == "posix" else PureWindowsPath(filepath)
+        )
         if not filepath.parent.name:
             # append local path
             filepath = Path.cwd() / filepath.name