|
47 | 47 | from ansys.dpf.core.nodes import Node, Nodes |
48 | 48 |
|
49 | 49 | if TYPE_CHECKING: # pragma: no cover |
| 50 | + from ansys.dpf.core import Operator, Result |
| 51 | + from ansys.dpf.core.fields_container import FieldsContainer |
50 | 52 | from ansys.dpf.core.meshed_region import MeshedRegion |
51 | 53 |
|
52 | 54 |
|
@@ -831,31 +833,30 @@ def plot_chart(fields_container, off_screen=False, screenshot=None): |
831 | 833 |
|
832 | 834 | def plot_contour( |
833 | 835 | self, |
834 | | - field_or_fields_container, |
835 | | - shell_layers=None, |
836 | | - meshed_region=None, |
837 | | - deform_by=None, |
838 | | - scale_factor=1.0, |
| 836 | + field_or_fields_container: Union[Field, FieldsContainer], |
| 837 | + shell_layers: eshell_layers = None, |
| 838 | + meshed_region: MeshedRegion = None, |
| 839 | + deform_by: Union[Field, Result, Operator] = None, |
| 840 | + scale_factor: float = 1.0, |
839 | 841 | **kwargs, |
840 | 842 | ): |
841 | 843 | """Plot the contour result on its mesh support. |
842 | 844 |
|
843 | 845 | You cannot plot a fields container containing results at several |
844 | | - time steps. |
| 846 | + time steps. Use :func:`FieldsContainer.animate` instead. |
845 | 847 |
|
846 | 848 | Parameters |
847 | 849 | ---------- |
848 | | - field_or_fields_container : dpf.core.Field or dpf.core.FieldsContainer |
| 850 | + field_or_fields_container: |
849 | 851 | Field or field container that contains the result to plot. |
850 | | - shell_layers : core.shell_layers, optional |
| 852 | + shell_layers: |
851 | 853 | Enum used to set the shell layers if the model to plot |
852 | | - contains shell elements. |
853 | | - deform_by : Field, Result, Operator, optional |
| 854 | + contains shell elements. Defaults to the top layer. |
| 855 | + deform_by: |
854 | 856 | Used to deform the plotted mesh. Must output a 3D vector field. |
855 | | - Defaults to None. |
856 | | - scale_factor : float, optional |
857 | | - Scaling factor to apply when warping the mesh. Defaults to 1.0. |
858 | | - **kwargs : optional |
| 857 | + scale_factor: |
| 858 | + Scaling factor to apply when warping the mesh. |
| 859 | + **kwargs: |
859 | 860 | Additional keyword arguments for the plotter. For more information, |
860 | 861 | see ``help(pyvista.plot)``. |
861 | 862 | """ |
|
0 commit comments