Merge branch 'mhanmer/operator_doc_template' into AnsMelanie/op-doc-custom

Author: ansMHanmer

doc/source/_static/dpf_operators.html

@@ -8348,7 +8348,7 @@ <h2 class="h2-main">Configurating operators</h2>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="5" ellipsis = "false"></pin-number></td><td><pin-name name="rigid_response"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td><td><div class = "pin-des-text"><p>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).</p>
 </div></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="spectrum_data" license="none" cat="result" plugin="mapdl" cpp-name="spectrum_data"></scripting-part></div><div class="operator" id="elemental to elemental nodal (fields container)" scripting_name="elemental_to_elemental_nodal_fc"plugin="core"cat="averaging"><h1 class="op-des-h1">averaging: elemental to elemental nodal (fields container)</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Transforms Elemental field to Elemental Nodal field.</p>
 </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="fields_container"></pin-name></td><td><req-type typeName="(fields_container)"></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"></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="3" 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></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="elemental_to_elemental_nodal_fc" license="none" cat="averaging" plugin="core" cpp-name="elemental_to_elemental_nodal_fc"></scripting-part></div><div class="operator" id="total pressure" scripting_name="total_pressure"plugin="core"cat="result"><h1 class="op-des-h1">result: total pressure</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Read Total Pressure by calling the readers defined by the datasources.</p>
-</div></figure><h2 class="op-des-h2">Supported file types</h2><supported-file-types content='{"cff":["flprj","cas"]}'></supported-file-types><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>
+</div></figure><h2 class="op-des-h2">Supported file types</h2><supported-file-types content='{"cff":["cas","flprj"]}'></supported-file-types><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>
 </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="(scopings_container | scoping)"></req-type></td><td><div class = "pin-des-text"><p>nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains</p>
 </div></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="streams_container"></pin-name></td><td><req-type typeName="(streams_container)"></req-type></td><td><div class = "pin-des-text"><p>result file container allowed to be kept open to cache data</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="4" ellipsis = "false"></pin-number></td><td><pin-name name="data_sources"></pin-name></td><td><req-type typeName="(data_sources)"></req-type></td><td><div class = "pin-des-text"><p>result file path container, used if no streams are set</p>

requirements/requirements_test.txt

@@ -1,10 +1,10 @@
 ansys-platform-instancemanagement==1.1.2
-coverage==7.8.2
+coverage==7.9.2
 graphviz==0.21
 imageio==2.37.0
 imageio-ffmpeg==0.6.0
 pypandoc_binary==1.15
-pytest==8.3.5
+pytest==8.4.1
 pytest-cov==6.1.1
 pytest-order==1.3.0
 pytest-rerunfailures==15.0

src/ansys/dpf/core/fields_container.py

@@ -549,7 +549,7 @@ def plot(self, label_space: dict = None, **kwargs):
         fields = self.get_fields(label_space=label_space)
         for f in fields:
             plt.add_field(field=f, **kwargs)
-        plt.show_figure(**kwargs)
+        return plt.show_figure(**kwargs)
 
     def animate(
         self,

src/ansys/dpf/core/plotter.py

@@ -435,7 +435,7 @@ def show_figure(self, **kwargs):
 
         # Show depending on return_cpos option
         kwargs_in = _sort_supported_kwargs(bound_method=self._plotter.show, **kwargs)
-        return self._plotter.show(**kwargs_in)
+        return self._plotter.show(**kwargs_in), self._plotter
 
     @staticmethod
     def _set_scalar_bar_title(kwargs):
@@ -1111,7 +1111,7 @@ def plot_contour(
         kwargs_in = _sort_supported_kwargs(
             bound_method=self._internal_plotter._plotter.show, **kwargs
         )
-        return self._internal_plotter._plotter.show(**kwargs_in)
+        return self._internal_plotter._plotter.show(**kwargs_in), self._internal_plotter._plotter
 
     def _plot_contour_using_vtk_file(self, fields_container, notebook=None):
         """Plot the contour result on its mesh support.